Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vaparr/pyoverseerr
Python interface to Overseerr
https://github.com/vaparr/pyoverseerr
Last synced: 6 days ago
JSON representation
Python interface to Overseerr
- Host: GitHub
- URL: https://github.com/vaparr/pyoverseerr
- Owner: vaparr
- License: mit
- Created: 2021-01-02T16:20:01.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-06T13:28:33.000Z (over 1 year ago)
- Last Synced: 2024-04-24T09:22:54.813Z (7 months ago)
- Language: Python
- Size: 50.8 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/pyoverseerr)
[](https://pepy.tech/project/pyoverseerr)
# pyoverseerr
This is a project for retrieving information from an Overseerr instance using their API.
# Installation
Run the following to install:
```python
pip install pyoverseerr
```
# Usage
#### Creating an object of your Overseerr instance
**Note:** You have to supply an `api_key` to successfully authenticate.
```python
import pyoverseerr
overseerr = pyoverseerr.Overseerr(
ssl=True,
host="192.168.1.120",
port="5000",
urlbase="overseerr/",
api_key="pixf64thuh2m7kbwwgkqp52yznbj4oyo"
)
```
#### Authenticate
```python
overseerr.authenticate()
```
#### Testing connection to Overseerr
```python
try:
overseerr.test_connection()
except pyoverseerr.OverseerrError as e:
print(e)
return
```
#### Retrieving data
```python
movies = overseerr.movie_requests
tv = overseerr.tv_requests
music = overseerr.music_requests
total = overseerr.total_requests
```
#### Searching
```python
movie_search = overseerr.search_movie("Movie Name")
tv_search = overseerr.search_tv("TV show name")
```
#### Requesting
```python
overseerr.request_movie("theMovieDbId")
overseerr.request_tv("theTvDbId", request_latest=True)
```
# License
This project is licensed under the MIT License - see the LICENSE.txt file for details.