# tvdb_api_client: an unofficial API for the TVDB
[![build][build_badge]][build_url]
[![lint][lint_badge]][lint_url]
[![tests][tests_badge]][tests_url]
[![license][licence_badge]][licence_url]
[![codecov][codecov_badge]][codecov_url]
[![readthedocs][readthedocs_badge]][readthedocs_url]
[![pypi][pypi_badge]][pypi_url]
[![downloads][pepy_badge]][pepy_url]
[![code style: black][black_badge]][black_url]
[![build automation: yam][yam_badge]][yam_url]
[![Lint: ruff][ruff_badge]][ruff_url]
`tvdb_api_client` is an unofficial API for the TVDB.
## In a nutshell
### Installation
The easiest way is to use [poetry](https://python-poetry.org/) to manage
your dependencies and add _tvdb_api_client_ to them.
```toml
[tool.poetry.dependencies]
tvdb_api_client = "*"
```
### Usage
Initialise the client (example using the django cache):
```python
from django.core.cache import cache
from tvdb_api_client import TVDBClient
client = TVDBClient("username", "user_key", "api_key", cache)
```
Once the client has been initialised, you can use it to get the
following info:
- get TV series by TVDB id
- get TV series by IMDb id
- find identifying info for a TV series by its name
- get episodes by TV series using its TVDB id
## Links
- [Documentation]
- [Changelog]
[build_badge]: https://github.com/spapanik/tvdb_api_client/actions/workflows/build.yml/badge.svg
[build_url]: https://github.com/spapanik/tvdb_api_client/actions/workflows/build.yml
[lint_badge]: https://github.com/spapanik/tvdb_api_client/actions/workflows/lint.yml/badge.svg
[lint_url]: https://github.com/spapanik/tvdb_api_client/actions/workflows/lint.yml
[tests_badge]: https://github.com/spapanik/tvdb_api_client/actions/workflows/tests.yml/badge.svg
[tests_url]: https://github.com/spapanik/tvdb_api_client/actions/workflows/tests.yml
[licence_badge]: https://img.shields.io/pypi/l/tvdb-api-client
[licence_url]: https://tvdb-api-client.readthedocs.io/en/stable/LICENSE/
[codecov_badge]: https://codecov.io/github/spapanik/tvdb-api-client/graph/badge.svg?token=Q20F84BW72
[codecov_url]: https://codecov.io/github/spapanik/tvdb-api-client
[readthedocs_badge]: https://readthedocs.org/projects/tvdb-api-client/badge/?version=latest
[readthedocs_url]: https://tvdb-api-client.readthedocs.io/en/latest/
[pypi_badge]: https://img.shields.io/pypi/v/tvdb-api-client
[pypi_url]: https://pypi.org/project/tvdb-api-client
[pepy_badge]: https://pepy.tech/badge/tvdb-api-client
[pepy_url]: https://pepy.tech/project/tvdb-api-client
[black_badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black_url]: https://github.com/psf/black
[yam_badge]: https://img.shields.io/badge/build%20automation-yamk-success
[yam_url]: https://github.com/spapanik/yamk
[ruff_badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json
[ruff_url]: https://github.com/charliermarsh/ruff
[Documentation]: https://tvdb-api-client.readthedocs.io/en/stable/
[Changelog]: https://tvdb-api-client.readthedocs.io/en/stable/CHANGELOG/
Raw data
{
"_id": null,
"home_page": "https://tvdb-api-client.readthedocs.io/en/stable/",
"name": "tvdb-api-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "imdb, tv series, tvdb",
"author": "Stephanos Kuma",
"author_email": "\"Stephanos Kuma\" <stephanos@kuma.ai>",
"download_url": "https://files.pythonhosted.org/packages/20/b7/7c15001146e8157465ed501421e4b8f3f1f0029473700b37c71754debb8d/tvdb_api_client-0.7.0.tar.gz",
"platform": null,
"description": "# tvdb_api_client: an unofficial API for the TVDB\n\n[![build][build_badge]][build_url]\n[![lint][lint_badge]][lint_url]\n[![tests][tests_badge]][tests_url]\n[![license][licence_badge]][licence_url]\n[![codecov][codecov_badge]][codecov_url]\n[![readthedocs][readthedocs_badge]][readthedocs_url]\n[![pypi][pypi_badge]][pypi_url]\n[![downloads][pepy_badge]][pepy_url]\n[![code style: black][black_badge]][black_url]\n[![build automation: yam][yam_badge]][yam_url]\n[![Lint: ruff][ruff_badge]][ruff_url]\n\n`tvdb_api_client` is an unofficial API for the TVDB.\n\n## In a nutshell\n\n### Installation\n\nThe easiest way is to use [poetry](https://python-poetry.org/) to manage\nyour dependencies and add _tvdb_api_client_ to them.\n\n```toml\n[tool.poetry.dependencies]\ntvdb_api_client = \"*\"\n```\n\n### Usage\n\nInitialise the client (example using the django cache):\n\n```python\nfrom django.core.cache import cache\nfrom tvdb_api_client import TVDBClient\n\nclient = TVDBClient(\"username\", \"user_key\", \"api_key\", cache)\n```\n\nOnce the client has been initialised, you can use it to get the\nfollowing info:\n\n- get TV series by TVDB id\n- get TV series by IMDb id\n- find identifying info for a TV series by its name\n- get episodes by TV series using its TVDB id\n\n## Links\n\n- [Documentation]\n- [Changelog]\n\n[build_badge]: https://github.com/spapanik/tvdb_api_client/actions/workflows/build.yml/badge.svg\n[build_url]: https://github.com/spapanik/tvdb_api_client/actions/workflows/build.yml\n[lint_badge]: https://github.com/spapanik/tvdb_api_client/actions/workflows/lint.yml/badge.svg\n[lint_url]: https://github.com/spapanik/tvdb_api_client/actions/workflows/lint.yml\n[tests_badge]: https://github.com/spapanik/tvdb_api_client/actions/workflows/tests.yml/badge.svg\n[tests_url]: https://github.com/spapanik/tvdb_api_client/actions/workflows/tests.yml\n[licence_badge]: https://img.shields.io/pypi/l/tvdb-api-client\n[licence_url]: https://tvdb-api-client.readthedocs.io/en/stable/LICENSE/\n[codecov_badge]: https://codecov.io/github/spapanik/tvdb-api-client/graph/badge.svg?token=Q20F84BW72\n[codecov_url]: https://codecov.io/github/spapanik/tvdb-api-client\n[readthedocs_badge]: https://readthedocs.org/projects/tvdb-api-client/badge/?version=latest\n[readthedocs_url]: https://tvdb-api-client.readthedocs.io/en/latest/\n[pypi_badge]: https://img.shields.io/pypi/v/tvdb-api-client\n[pypi_url]: https://pypi.org/project/tvdb-api-client\n[pepy_badge]: https://pepy.tech/badge/tvdb-api-client\n[pepy_url]: https://pepy.tech/project/tvdb-api-client\n[black_badge]: https://img.shields.io/badge/code%20style-black-000000.svg\n[black_url]: https://github.com/psf/black\n[yam_badge]: https://img.shields.io/badge/build%20automation-yamk-success\n[yam_url]: https://github.com/spapanik/yamk\n[ruff_badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json\n[ruff_url]: https://github.com/charliermarsh/ruff\n[Documentation]: https://tvdb-api-client.readthedocs.io/en/stable/\n[Changelog]: https://tvdb-api-client.readthedocs.io/en/stable/CHANGELOG/\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A python client for TVDB rest API",
"version": "0.7.0",
"project_urls": {
"Documentation": "https://tvdb-api-client.readthedocs.io/en/stable/",
"Homepage": "https://tvdb-api-client.readthedocs.io/en/stable/",
"Repository": "https://github.com/spapanik/tvdb_api_client"
},
"split_keywords": [
"imdb",
" tv series",
" tvdb"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "84011daeeb1d7aa2a049ef5f5fe81335229b4394c5bfcf8f24babc01736052c4",
"md5": "e9b4c655a76f6ac2945d4cdbb6b9b7e4",
"sha256": "61e9cb268bf6ab77ddaa7808c368eb03804ecd19048b4383e9379a536fcdb8e9"
},
"downloads": -1,
"filename": "tvdb_api_client-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9b4c655a76f6ac2945d4cdbb6b9b7e4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7995,
"upload_time": "2025-02-01T11:40:27",
"upload_time_iso_8601": "2025-02-01T11:40:27.928705Z",
"url": "https://files.pythonhosted.org/packages/84/01/1daeeb1d7aa2a049ef5f5fe81335229b4394c5bfcf8f24babc01736052c4/tvdb_api_client-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "20b77c15001146e8157465ed501421e4b8f3f1f0029473700b37c71754debb8d",
"md5": "f39090f4cf6a69f416cac77cc4a01a31",
"sha256": "345a9ab05a77ea174ee0abdfd5e105fd1d11b6cbc9e70c63c86406c0ad583342"
},
"downloads": -1,
"filename": "tvdb_api_client-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "f39090f4cf6a69f416cac77cc4a01a31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6865,
"upload_time": "2025-02-01T11:40:29",
"upload_time_iso_8601": "2025-02-01T11:40:29.804164Z",
"url": "https://files.pythonhosted.org/packages/20/b7/7c15001146e8157465ed501421e4b8f3f1f0029473700b37c71754debb8d/tvdb_api_client-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-01 11:40:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spapanik",
"github_project": "tvdb_api_client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tvdb-api-client"
}
JSON
