Skip to main content

A Python wrapper for The Movie Database API v3

Project description

A wrapper for The Movie Database API v3

tmdbsimple is a wrapper, written in Python, for The Movie Database (TMDb) API v3. By calling the functions available in tmdbsimple you can simplify your code and easily access a vast amount of movie, tv, and cast data. To learn more about The Movie Database API, check out the overview page http://www.themoviedb.org/documentation/api and documentation page https://developers.themoviedb.org/3.

Features

  • COMPLETELY UPDATED AND FULLY TESTED. Updated with the latest Account, Authentication, Certification, GuestSession, List, Movie, People, Timezones, TV, TV Season, and TV Episode methods.

  • Supports and tested under Python 2.7.6, 3.3.5, and 3.4.0

  • One-to-one mapping between tmdbsimple functions and TMDb methods.

  • Implements all TMDb methods, including Accounts and Authentication.

  • Implements new TV features.

  • Easy to access data using Python class attributes.

  • Easy to experiment with tmdbsimple functions inside the Python interpreter.

  • Code tested with unittests, which illustrate the function call syntax.

Installation

tmdbsimple is available on the Python Package Index (PyPI) at https://pypi.python.org/pypi/tmdbsimple.

You can install tmdbsimple using one of the following techniques.

  • Use pip:

pip install tmdbsimple
  • 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 The Movie Database to access the API. To obtain a key, follow these steps:

  1. Register for and verify an account.

  2. Log into your account.

  3. Select the API section on left side of your account page.

  4. Click on the link to generate a new API key and follow the instructions.

Examples

Once you have the tmdbsimple package installed and a TMDb API key, you can start to play with the data.

First, import the library and assign your API_KEY.

>>> import tmdbsimple as tmdb
>>> tmdb.API_KEY = 'YOUR_API_KEY_HERE'

To communicate with The Movie Database API, create an instance of one of the object types, call one of the methods on the instance, and access the instance attributes. Use keys to access the values of attributes that are dictionaries. In this example, we create a movie instance for ‘The Matrix’ and determine the budget and certification.

>>> movie = tmdb.Movies(603)
>>> response = movie.info()
>>> movie.title
'The Matrix'
>>> movie.budget
63000000
>>> response = movie.releases()
>>> for c in movie.countries:
...    if c['iso_3166_1'] == 'US':
...         print(c['certification'])
...
'R'

Let’s play with the interface a bit more. Suppose you and your friend are arguing over which movie in the Bourne series was most popular. Your friend says the first in a series is always most popular. You disagree.

>>> search = tmdb.Search()
>>> response = search.movie(query='The Bourne')
>>> for s in search.results:
...     print(s['title'], s['id'], s['release_date'], s['popularity'])
...
The Bourne Ultimatum 2503 2007-08-03 55.2447062124256
The Bourne Supremacy 2502 2004-07-23 43.4553609681985
The Bourne Identity 2501 2002-06-06 38.5531563780592
The Bourne Legacy 49040 2012-08-10 9.90635210153143
The Bourne Identity 8677 1988-05-08 1.53988446573129
Bette Bourne: It Goes with the Shoes 179304  0.23

You are correct! Now you claim the producers should be able to make sequels cheaper, based on what they learned from making the first movie. To be fair, you compute the budget per minute of runtime. Your friend disagrees, claiming the producers spend more money trying to out do the previous sequel.

>>> identity = tmdb.Movies(2501)
>>> response = identity.info()
>>> identity.budget, identity.runtime
(60000000, 119)
>>> int(identity.budget/identity.runtime)
504201
>>> supremacy = tmdb.Movies(2502)
>>> response = supremacy.info()
>>> supremacy.budget, supremacy.runtime
(75000000, 108)
>>> int(supremacy.budget/supremacy.runtime)
694444
>>> ultimatum = tmdb.Movies(2503)
>>> response = ultimatum.info()
>>> ultimatum.budget, ultimatum.runtime
(70000000, 115)
>>> int(ultimatum.budget/ultimatum.runtime)
608695

In this case you are both correct. The third movie was cheaper than the second, which was more expensive than the first.

You also can call one of the methods without explicitly instanciating an object.

>>> response = tmdb.Movies(603).info()
>>> response['budget']
63000000

If you use Authentication to access a user Account, be sure to check out https://www.themoviedb.org/documentation/api/sessions.

If you like this wrapper, and would like access to even more movie and TV data, check out rtsimple https://pypi.python.org/pypi/rtsimple, a wrapper for the Rotten Tomatoes API.

Project details


Download files

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

Source Distribution

tmdbsimple-2.2.14.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tmdbsimple-2.2.14-py2.py3-none-any.whl (34.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file tmdbsimple-2.2.14.tar.gz.

File metadata

  • Download URL: tmdbsimple-2.2.14.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for tmdbsimple-2.2.14.tar.gz
Algorithm Hash digest
SHA256 62e72b063a7a44c0bccdb90488fa44ff5b1ca7b4241f21e3326636a022186262
MD5 30d4439b26670e47e32a5e9885b3c1ef
BLAKE2b-256 39a42842fd368d873a3455f1223cf33e67c3996047c007dd58bb6bca91926e58

See more details on using hashes here.

File details

Details for the file tmdbsimple-2.2.14-py2.py3-none-any.whl.

File metadata

  • Download URL: tmdbsimple-2.2.14-py2.py3-none-any.whl
  • Upload date:
  • Size: 34.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for tmdbsimple-2.2.14-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ab452550d4ce2e9526018a8608bda85417188f098fcb0454985d404dca71a51e
MD5 be7ad178c877a5d214f2746414b65ba7
BLAKE2b-256 3aa4d0149fd502fb4f7ad4b3796688e9cb8470cc2f4cbd030c185601934fddb3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page