A python module to retrieve information from Overseerr.
Project description
pyoverseerr
This is a project for retrieving information from an Overseerr instance using their API.
Installation
Run the following to install:
pip install pyoverseerr
Usage
Creating an object of your Overseerr instance
Note: You have to supply an api_key
to successfully authenticate.
import pyoverseerr
overseerr = pyoverseerr.Overseerr(
ssl=True,
host="192.168.1.120",
port="5000",
urlbase="overseerr/",
api_key="pixf64thuh2m7kbwwgkqp52yznbj4oyo"
)
Authenticate
overseerr.authenticate()
Testing connection to Overseerr
try:
overseerr.test_connection()
except pyoverseerr.OverseerrError as e:
print(e)
return
Retrieving data
movies = overseerr.movie_requests
tv = overseerr.tv_requests
music = overseerr.music_requests
total = overseerr.total_requests
Searching
movie_search = overseerr.search_movie("Movie Name")
tv_search = overseerr.search_tv("TV show name")
Requesting
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyoverseerr-0.1.33.tar.gz
(5.0 kB
view hashes)
Built Distribution
Close
Hashes for pyoverseerr-0.1.33-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cab5b416f1957e29edd3b7b2c5a7ab90ea7766c87edbe3cdc4cf74a4251dbee |
|
MD5 | 93ce27d1d9d008e99d2ecdb42702645f |
|
BLAKE2b-256 | 02a091fc4cec7d57662baa5d09e8671b486ff20cf84a1f2af27390c288d6044b |