A Python wrapper for TMDb API
Project description
ezapi-tmdb
A Python wrapper for TMDb API, supporting version 3 and 4
Install
From PyPi
pip install ezapi-tmdb
From GitHub
pip install git+https://github.com/zehengl/ezapi-tmdb.git
Usage
- All endpoints are mapped to functions in a
TMDb
object - All query string params are used as keyword arguments
Version 3 Example
See Version 3 documents for detailed API usage.
from tmdb import TMDb3
api_key = "..."
tmdb = TMDb3(api_key)
# query string params are used as keyword arguments
print(tmdb.get_popular_movies(region="US"))
print(tmdb.get_tvs_on_the_air(page=10))
# create session_id with username/password login
username = "..."
password = "..."
request_token = tmdb.create_request_token().get("request_token")
tmdb.create_session_with_login(username, password, request_token)
session_id = tmdb.create_session(request_token).get("session_id")
# some endpoints require session_id
print(tmdb.get_account_details(session_id=session_id))
# store global options, language / region for example
tmdb.set_options(language="de", region="de")
tmdb.get_trending("all", "week")
# reset global options
tmdb.reset_options()
# configure image languages globally
tmdb.set_options(include_image_language=["en", "null"])
tmdb.get_movie_images(597)
# url param per request would overwrite global options
tmdb.get_movie_images(597, include_image_language=["de", "fr"])
Version 4 Example
See Version 4 documents for detailed API usage.
from tmdb import TMDb4
# API Read Access Token from the settings page
access_token = "..."
tmdb = TMDb4(access_token)
# create a user access token
request_token = tmdb.create_request_token().get("request_token")
print(f"https://www.themoviedb.org/auth/access?request_token={request_token}")
# click on the link above, sign in, then approve access
resp = tmdb.create_access_token(request_token)
# extract the user access token and account id for v4 api
user_access_token = resp.get("access_token")
account_id = resp.get("account_id")
tmdb.update_access_token(user_access_token)
tmdb.get_list(14105)
tmdb.get_account_favorite_movies(account_id)
Test
git clone git@github.com:zehengl/ezapi-tmdb.git
export api_key="..."
export username="..."
export password="..."
export access_token="..."
cd ezapi-tmdb
python setup.py test
Use $Env:api_key="..."
, $Env:username="..."
, $Env:password="..."
, and $Env:access_token="..."
to set the api key, username, password, and access token environment variables on Windows.
Credits
-
Icon from www.themoviedb.org
Contributors ✨
Thanks goes to these wonderful people (emoji key):
Cologler 💻 |
Rafael Pierre 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ezapi_tmdb-0.7.2.tar.gz
.
File metadata
- Download URL: ezapi_tmdb-0.7.2.tar.gz
- Upload date:
- Size: 15.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a5353bc3de8b94efedd358a670c5e1fae2d905ec3a3f96c8e88209c039cc97b |
|
MD5 | 29c471fb269ef16a9bbb0a5aa23f1d86 |
|
BLAKE2b-256 | f894e2838cb841d2f775daaf3acaff22ea9ea837f992484a69938aa9653b393e |
File details
Details for the file ezapi_tmdb-0.7.2-py3-none-any.whl
.
File metadata
- Download URL: ezapi_tmdb-0.7.2-py3-none-any.whl
- Upload date:
- Size: 31.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70de42ddbfdee51f30027261069fe9fecab2da2bda8ce56f15f8a0b522c86758 |
|
MD5 | 03242f8482e2110952b269ca29662d45 |
|
BLAKE2b-256 | 2a4ab1a78159b948f47e3f73c329e1e1a9ee44f27258023d2237f4a45aca1ab5 |