Skip to content

fix readme example #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lukengda wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix readme example #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92aaa50
docs: fix usage example in README.md
lukengda Sep 5, 2024
e7a1bfb
docs: format file with markdownlint
lukengda Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# tvdb-v4-python

This is the official tvdb api v4 python package

### Installation
## Installation

```bash
python3 -m pip install tvdb_v4_official
```
### Getting Started
some projects require a user supplied pin as well as an apikey

## Getting Started

> Note: some projects require a user supplied pin as well as an apikey

```python3
import tvdb_v4_official
Expand All @@ -27,8 +31,8 @@ series = tvdb.get_series(121361)
series = tvdb.get_series_extended(121361)
for season in sorted(series["seasons"], key=lambda x: (x["type"]["name"], x["number"])):
if season["type"]["name"] == "Aired Order" and season["number"] == 1:
season = tvdb.get_season_extended(season["id"])
break
season = tvdb.get_season_extended(season["id"])
break
else:
season = None
if season is not None:
Expand All @@ -49,9 +53,9 @@ for c in movie["characters"]:
print(c)

# fetching a person record
person = tvdb.get_person_extended(characters[0]["peopleId"])
person = tvdb.get_person_extended(movie["characters"][0]["peopleId"])
print(person)

# using since If-Modifed-Since parameter
# using since If-Modified-Since parameter
series = tvdb.get_series_extended(393199, if_modified_since="Wed, 30 Jun 2022 07:28:00 GMT")
```