Skip to content

Commit

Permalink
add region to search_tmdb_movies docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dbatten5 committed Nov 20, 2021
1 parent 9275091 commit 3a149de
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ through `search_tmdb_movies`. Note that this search performs a lot quicker than
'overview': 'Set in the 22nd century, The Matrix tells the story of a computer hacker...'
'popularity': 79.956,
'poster_path': '/f89U3ADr1oiB1s9GkdPOEpXUk5H.jpg',
'release_date': '1999-06-11',
'release_date': '1999-03-30',
'title': 'The Matrix',
'video': False,
'vote_average': 8.2,
Expand All @@ -68,6 +68,23 @@ through `search_tmdb_movies`. Note that this search performs a lot quicker than
}
```

By default the `release_date` will be the US release date. You can specify a different
region by providing a region argument:

```python
>>> from phylm.tools import search_tmdb_movies
>>> search_tmdb_movies("The Matrix", region="gb")
[{
'id': 603,
...
'release_date': '1999-06-11',
'title': 'The Matrix',
...
}, {
...
}
```

::: phylm.tools.search_tmdb_movies
rendering:
show_signature_annotations: true
Expand Down

0 comments on commit 3a149de

Please sign in to comment.