Metadata-Version: 2.3
Name: tvdb_api_client
Version: 0.8.0
Summary: A python client for TVDB rest API
Keywords: tvdb,imdb,tv series
Author: Stephanos Kuma
Author-email: Stephanos Kuma <stephanos@kuma.ai>
License: BSD-3-Clause
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Intended Audience :: Developers
Requires-Dist: dj-settings~=8.0
Requires-Dist: pathurl~=0.8
Requires-Dist: pyutilkit~=0.11
Requires-Dist: requests>=2.34.2,<3.0
Requires-Python: >=3.10
Project-URL: homepage, https://tvdb-api-client.readthedocs.io/en/stable/
Project-URL: repository, https://github.com/spapanik/tvdb_api_client
Project-URL: documentation, https://tvdb-api-client.readthedocs.io/en/stable/
Description-Content-Type: text/markdown

# 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]
[![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

[uv] is an extremely fast Python package installer.
You can use it to install `tvdb_api_client` and try it out:

```console
$ uv pip install tvdb_api_client
```

### Usage

Initialise the client and fetch data:

```python
from tvdb_api_client import TheTVDBClient

client = TheTVDBClient(api_key="your-api-key")

# Get a TV series by its TVDB id
series = client.get_series_by_id(81189)  # Breaking Bad

# Get all episodes for a TV series
episodes = client.get_episodes_by_series(81189)
```

Once the client has been initialised, you can use it to:

- get a TV series by its TVDB id
- get all episodes for a TV series by its TVDB id
- access raw API responses for custom processing

## 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
[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
[uv]: https://github.com/astral-sh/uv
[Documentation]: https://tvdb-api-client.readthedocs.io/en/stable/
[Changelog]: https://tvdb-api-client.readthedocs.io/en/stable/CHANGELOG/
