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 either a password
or an api_key
to successfully authenticate. The api_key
will take precedence if both are supplied.
import pyoverseerr
overseerr = pyoverseerr.Overseerr(
ssl=True,
host="192.168.1.120",
port="5000",
urlbase="overseerr/",
username="MyUsername",
password="MyPassword",
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")
music_search = overseerr.search_music_album("Album name")
Requesting
overseerr.request_movie("theMovieDbId")
overseerr.request_tv("theTvDbId", request_latest=True)
overseerr.request_music("foreignAlbumId")
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.10.tar.gz
(3.7 kB
view hashes)
Built Distribution
Close
Hashes for pyoverseerr-0.1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 922058cc976f99a00e06e8dcb1aa386c7904e388db2bbe2ec7e59094eebd89e6 |
|
MD5 | e0f4720b799de8e6374a4ba1a0400ba0 |
|
BLAKE2b-256 | 64264ae8678d7c411f39e1550b4cce8e563a6e1746ebfa9756ab39890d8e3db1 |