atmdb

aTMDb

.. image:: https://img.shields.io/pypi/v/atmdb.svg :target: https://pypi.python.org/pypi/atmdb :alt: PyPI Version

.. image:: https://travis-ci.org/textbook/atmdb.svg?branch=master :target: https://travis-ci.org/textbook/atmdb :alt: Travis Build Status

.. image:: https://coveralls.io/repos/github/textbook/atmdb/badge.svg?branch=master :target: https://coveralls.io/github/textbook/atmdb?branch=master :alt: Code Coverage

.. image:: https://www.quantifiedcode.com/api/v1/project/370d26a2062c4b148534b576ea0fc11b/badge.svg :target: https://www.quantifiedcode.com/app/project/370d26a2062c4b148534b576ea0fc11b :alt: Code Issues

.. image:: https://img.shields.io/badge/license-ISC-blue.svg :target: https://github.com/textbook/atmdb/blob/master/LICENSE :alt: ISC License

Asynchronous API wrapper for TMDb_.

Compatibility

aTMDb uses asyncio_ with the async and await syntax, so is only compatible with Python versions 3.5 and above.

Installation

atmdb can be installed from PyPI_ using pip::

pip install atmdb

Testing

You can run the tests with python setup.py test. To include the integration suite, ensure that the environment variable TMDB_API_TOKEN is set to a valid API token, and use --runslow if running py.test directly.

Usage

Client ......

The core TMDbClient must be instantiated with a valid API token (see the API FAQ_ for more information), either directly::

from atmdb import TMDbClient

client = TMDbClient(api_token='<insert your token here>')

or as the TMDB_API_TOKEN environment variable::

client = TMDbClient.from_env()

You can then access the API by calling asynchronous helper methods on the client instance::

movie = await client.get_movie(550)
assert movie.title == 'Fight Club'

Any API endpoints not currently exposed via the helper methods can be accessed by using the url_builder and get_data methods directly, for example::

url = client.url_builder('company/{company_id}', dict(company_id=508))
                       # ^ endpoint            # ^ parameters to insert
company = await client.get_data(url)
assert company.get('name') == 'Regency Enterprises'

Note that, if you aren't using a helper method, the result is just a vanilla dictionary.

Utilities .........

aTMDb also exposes utilities for working with the API and models at a higher level of abstraction, for example::

from aTMDb import TMDbClient
from aTMDb.utils import find_overlapping_actors

actors = await find_overlapping_actors(
    ['monty python holy grail', 'meaning of life'],
    TMDbClient(api_token='<insert your token here>'),
)
assert any(person.name == 'Eric Idle' for person in overlap)

Documentation

Additional documentation is available on PythonHosted_.

.. _API FAQ: https://www.themoviedb.org/faq/api .. _asyncio: http://aiohttp.readthedocs.io/ .. _PyPI: https://pypi.python.org/pypi/atmdb .. _PythonHosted: https://pythonhosted.org/atmdb/ .. _TMDb: https://www.themoviedb.org/