Skip to main content

A Python wrapper for TheTVDb Database API v2

Project description

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.
  • 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tvdbsimple, version 1.0.6
Filename, size File type Python version Upload date Hashes
Filename, size tvdbsimple-1.0.6.tar.gz (11.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page