pyoverseerr 0.1.40

A python module to retrieve information from Overseerr.

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.