Skip to main content

tvdb_client: A python client library for the new TVDB API

https://codeship.com/projects/997e1f20-9267-0134-fa6e-42e39fd99f49/status?branch=master

The tvdb_client provides integration with the TheTVDB API and allows interaction with all of its public APIs in both versions: V1 and V2.

The tvdb_client library will provide different client classes for the V1 and V2 API versions from TheTVDB for they are very different conceptually and technically (V1 is HTTP Get request based with XML response, while V2 is all RESTful JSON based).

This library is powered by the fantastic python Requests library and the awesome python lxml.

tvdb_client is not supported nor endorsed by TheTVDB.

Client Classes

  • ApiV1Client: Provides access to TheTVDB V1 APIs which are based on HTTP Get requests with XML based responses. The API documentation from TheTVDB can be found at API v1 description.

  • ApiV2Client: Provides access to TheTVDB V2 APIs which are all RESTfull JSON APIs. The API information is very well documented at API v2 description.

V1 API Client

The V1 API Client is implemented by class ApiV1Client. Its constructor takes the api key, as required by TheTVDB.

Currently, the implementation of the methods for its APIs is under development.

V2 API Client

The V2 API Client is implemented on class ApiV2Client. Its constructor receives the user identification (api key, username and account identified) as required by TheTVDB and optionally the language option.

This client implements method for all the APIs documented in TheTVDB swagger with the exception of those that returns information on the parameters required for certain APIs.

The client is very easy to use as provided by the example below:

>>> from tvdb_client import ApiV2Client
>>> api_client = ApiV2Client('USERNAME', 'API_KEY', 'ACCOUNT_IDENTIFIER')
>>> api_client.login()
>>> api_client.is_authenticated
True
>>> series = api_client.search_series(name='Game of Thrones')
>>> print series
{u'data': [{u'status': u'Continuing', u'network': u'HBO', u'overview': u"Seven noble families fight for control of
the mythical land of Westeros. Friction between the houses leads to full-scale war. All while a very ancient evil
awakens in the farthest north. Amidst the war, a neglected military order of misfits, the Night's Watch, is all that
 stands between the realms of men and the icy horrors beyond.", u'seriesName': u'Game of Thrones', u'firstAired':
 u'2011-04-17', u'banner': u'graphical/121361-g19.jpg', u'id': 121361, u'aliases': []}, {u'status': u'Continuing',
 u'network': u'YouTube', u'overview': u'A spoof/parody Based on HBO\'s hit series "A Game of Thrones" and George RR
 Martin\'s A Song of Ice and Fire', u'seriesName': u'Game of Thrones: Cartoon Parody', u'firstAired': u'2011-05-07',
  u'banner': u'', u'id': 311939, u'aliases': []}]}
>>> type(series)
<type 'dict'>

Status and updates

  • May 2016: Development started and API V2 Client is up for business!

  • May 2020: Fix to client shared lib (version 0.1.2)

Contact

Should you have any questions, suggestions or wishes to contribute, please drop me an email at thilux.systems@gmail.com.

Metadata

Release files for tvdb-client 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tvdb-client 0.1.2
File Size Uploaded
tvdb_client-0.1.2.tar.gz 10.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tvdb-client 0.1.2
File Interpreter ABI Platform
tvdb_client-0.1.2-py3.7.egg Legacy Egg format - - Details

Total release size: 35.5 kB

Release files / tvdb_client-0.1.2.tar.gz

Download URL tvdb_client-0.1.2.tar.gz
Size 10.9 kB
Tags Source
SHA-256 checksum
How to use checksums
752967cabc9ff8146bca2fe2f96c04b43b517e88da55bb4f69131cb90d90304f
BLAKE2b-256 checksum
How to use checksums
3d453edf6f6453c8d5f895bd4e30516e649c0369b369b0d80676ca7f3785fd3a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

Release files / tvdb_client-0.1.2-py3.7.egg

Download URL tvdb_client-0.1.2-py3.7.egg
Size 24.6 kB
Tags Egg
SHA-256 checksum
How to use checksums
795012cfc67971515dced1ae33ec9e08d46c1f9d233313b0b2e80709171fee00
BLAKE2b-256 checksum
How to use checksums
67c1ee8ad8c4bfaec463a13d41f53f4cc112439cdcdc12476daf35a1cb1c7ba7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page