Python IMDB client using the IMDB json web service made available for their iOS app.
Python
Latest commit 028d139 Jan 11, 2018 @richardasaurus richardasaurus Update README.md

README.md

ImdbPie

PyPI Python Versions Build Status

Python IMDB client using the IMDB json web service made available for their iOS app.

API Terminology

  • Title this can be a movie, tv show, video, documentary etc.
  • Name this can be a credit, cast member, any person generally.

Installation

To install imdbpie, simply:

pip install imdbpie

How To Use

Initialise the client

from imdbpie import Imdb
imdb = Imdb()

Available methods

NOTE: For each client method, if the resource cannot be found they will raise LookupError, if there is an API error then ImdbAPIError will raise.

get_title

imdb.get_title('tt0111161')
# Returns a dict containing title information

get_title_genres

imdb.get_title_genres('tt0303461')
# Returns a dict containing title genres information

get_title_credits

imdb.get_title_credits('tt0303461')
# Returns a dict containing title credits information

get_title_quotes

imdb.get_title_quotes('tt0303461')
# Returns a dict containing title quotes information

get_title_ratings

imdb.get_title_ratings('tt0303461')
# Returns a dict containing title ratings information

get_title_connections

imdb.get_title_connections('tt0303461')
# Returns a dict containing title connections information

get_title_similarities

imdb.get_title_similarities('tt0303461')
# Returns a dict containing title similarities information

get_title_videos

imdb.get_title_videos('tt0303461')
# Returns a dict containing title videos information

get_title_episodes

imdb.get_title_episodes('tt0303461')
# Returns a dict containing season and episodes information

get_title_plot

imdb.get_title_plot('tt0111161')
# Returns a dict containing title plot information

get_title_plot_synopsis

imdb.get_title_plot_synopsis('tt0111161')
# Returns a dict containing title plot synopsis information

get_title_awards

imdb.get_title_awards('tt0111161')
# Returns a dict containing title awards information

get_title_releases

imdb.get_title_releases('tt0111161')
# Returns a dict containing releases information

get_title_versions

imdb.get_title_versions('tt0111161')
# Returns a dict containing versions information (meaning different versions of this title for different regions, or different versions for DVD vs Cinema)

get_title_user_reviews

imdb.get_title_user_reviews('tt0111161')
# Returns a dict containing user review information

get_title_metacritic_reviews

imdb.get_title_metacritic_reviews('tt0111161')
# Returns a dict containing metacritic review information

get_title_images

imdb.get_title_images('tt0111161')
# Returns a dict containing title images information

title_exists

imdb.title_exists('tt0111161')
# Returns True if exists otherwise False

search_for_title

imdb.search_for_title("The Dark Knight")
# Returns list of dict results
[{'title': "The Dark Knight", 'year':  "2008", 'imdb_id': "tt0468569"},{'title' : "Batman Unmasked", ...}]

search_for_name

imdb.search_for_name("Christian Bale")
# Returns list of dict results
[{'imdb_id': 'nm0000288', 'name': 'Christian Bale'},{'imdb_id': 'nm7635250', ...}]

get_name

imdb.get_name('nm0000151')
# Returns a dict containing person/name information

get_name_filmography

imdb.get_name_filmography('nm0000151')
# Returns a dict containing person/name filmography information

get_name_images

imdb.get_name_images('nm0000032')
# Returns a dict containing person/name images information

get_name_videos

imdb.get_name_videos('nm0000032')
# Returns a dict containing person/name videos information

validate_imdb_id

imdb.validate_imdb_id('tt0111161')
# Raises `ValueError` if not valid

get_popular_titles

imdb.get_popular_titles()
# Returns a dict containing popular titles information

get_popular_shows

imdb.get_popular_shows()
# Returns a dict containing popular titles information

get_popular_movies

imdb.get_popular_movies()
# Returns a dict containing popular titles information

Requirements

1. Python 2 or 3
2. See requirements.txt

Running the tests

pip install -r test_requirements.txt
py.test src/tests