Giter Club home page Giter Club logo

tvdbsimple's Introduction

TheTVDb wrapper module

https://travis-ci.org/phate89/tvdbsimple.svg?branch=master

tvdbsimple is a wrapper, written in Python, for TheTVDB API v2. By calling the functions available in tvdbsimple you can simplify your code and easily access a vast amount of tv series data. To learn more about TheTVDb API, check out the website api page.

Features

  • Full API implementation. Supports Search, Series, Episode, Updated, User and Languages methods.
  • Updated with the latest JSON API.
  • Fully tested with automated tests and travis.ci.
  • Supports Python 2.7, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8.
  • Easy to access data using Python class attributes.
  • Easy to experiment with tvdbsimple functions inside the Python interpreter.

Installation

tvdbsimple is available on the Python Package Index (PyPI).

You can install tvdbsimple using one of the following techniques:

  • Use pip: pip install tvdbsimple
  • Download the .zip or .tar.gz file from PyPI and install it yourself
  • Download the source from Github and install it yourself

If you install it yourself, also install requests.

API Key

You will need an API key to TheTVDb to access the API. To obtain a key, follow these steps:

  1. Register for and verify an account.
  2. Log into your account.
  3. Go to this page and fill your details to generate a new API key.

Documentation

All the functions are fully documented in the docs folder and in the github wiki page but you can find several use examples in the examples page.

Issues

If you find any issue please post in the github issue page with all the information possible to reproduce the issue

Support

  • If you would like contribute to the projects, feel free to do: fork, pull-request, issues, etc... They're higly welcome
  • Instead if you would like offer me a coffee or beer: Donate with PayPal

Thanks

  • To celiao, her tmdbsimple module inspired my work here
  • To BurntSushi, his pdoc module helped me documenting the module
  • To TheTVDb website for providing the content and the api

tvdbsimple's People

Contributors

phate89 avatar rmartin16 avatar 3lixy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.