Python wrapper around The Open Movie Database API (a.k.a. OMDb API): http://omdbapi.com/

NOTE: This library and its author are not endorsed by or affiliated with OMDbAPI.com.

Using pip:

pip install omdb

• requests >= 2.0.1

Each omdb.py method supports the same parameters as the OMDb API.

NOTE: By default all OMDb API responses are formatted as JSON. However, OMDb API also supports responses formatted as XML. Since omdb.py will handle JSON to dict conversion automatically, it's generally not necessary (nor is it supported by the main ombd.py methods) to return XML formatted responses. But this can be accomplished by directly using omdb.request:

import omdb

# must use OMDb API parameters
res = omdb.request(t='True Grit', y=1969, r='xml')
xml_content = res.content

All methods are accessible via:

import omdb

# omdb.<method>

While generally not necessary, one can use the lower level OMDb API Client for accessing the API:

from omdb import Client

client = Client()

Movie data returned from the OMDb API is converted to a custom dict subclass which allows both data['key'] and data.key access.

There are two main models:

• omdb.models.Search (a list of Item instances)
• omdb.models.Item

Which can be accessed like the following:

import omdb

movie = omdb.title('True Grit')
movie.title == 'True Grit'
movie['title'] == 'True Grit'

search = omdb.search('True Grit')
search[0].title == 'True Grit'

All fields from the OMDb API are converted from CamelCaseFields to underscore_fields:

import omdb

# include full plot and Rotten Tomatoes data
omdb.get(title='True Grit', year=1969, fullplot=True, tomatoes=True)

# search by string
omdb.search('True Grit')

# search movies by string
omdb.search_movie('True Grit')

# search episodes by string
omdb.search_episode('True Grit')

# search series by string
omdb.search_series('True Grit')

# get by IMDB id
omdb.imdbid('tt0065126')

# get by title
omdb.title('True Grit')

# include tomatoes data by default
omdb.set_default('tomatoes', True)
omdb.title('True Grit') == omdb.title('True Grit', tomatoes=True)

# lower level API request
omdb.request(t='True Grit', y=1969, plot='full', tomatoes='true')

Returns:

A requests.Response object.

Under the hood, omdb.py uses the requests library. For a listing of explicit exceptions raised by requests, see Requests: Errors and Exceptions.

By default requests will not raise an Exception when an HTTP response's status code is not 200. However, omdb.py WILL raise an requests.exceptions.HTTPError error for any response with a non-200 status code.