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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for pyoverseerr-0.1.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80c1b146544bb6a60acd8ce9eb645ad7a571efe0e796da18e77412a7c3d5c0b6 |
|
MD5 | 05972cc00e4d7fa7bddd7ef9f8484294 |
|
BLAKE2b-256 | 4534ed183a2428ca545f44cf9389a52e4f63e017cd51e68753731883b1bef5ad |