Skip to main content

A python module to retrieve information from Overseerr. Continued!

Project description

PyPI version Downloads

pyoverseerr

This is a project for retrieving information from an Overseerr instance using their API.

Installation

Run the following to install:

pip install pyoverseerrcontinued

Usage

Creating an object of your Overseerr instance

Note: You have to supply an api_key to successfully authenticate.

import pyoverseerr

overseerr = pyoverseerr.Overseerr(
    url="192.168.1.120:5055",
    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

# Searching for movies with "Movie Name on the first page"
movie_search = overseerr.search_movie("Movie Name", 1)
# Searching for movies with "TV show name on the second page"
tv_search = overseerr.search_tv("TV show name", 2)

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyoverseerrcontinued-0.0.3.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyoverseerrcontinued-0.0.3-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

Details for the file pyoverseerrcontinued-0.0.3.tar.gz.

File metadata

  • Download URL: pyoverseerrcontinued-0.0.3.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for pyoverseerrcontinued-0.0.3.tar.gz
Algorithm Hash digest
SHA256 9e5bb7b8880a660a9381f9fed85ec6e15a9732fbb35b4a0b0ea4bf13ace654b7
MD5 bf23f35bb5edf98c639f304278792f70
BLAKE2b-256 2defd8b69286c15acb1a8951568d52715ccf9e70279acf868e7cbe4427233555

See more details on using hashes here.

File details

Details for the file pyoverseerrcontinued-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for pyoverseerrcontinued-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c6de52b3446f59bf4568ff9d31a386c22e4b70e1987ae0480d2e098cba3d8f3d
MD5 62c762dc17e2adb15af62d48860a1834
BLAKE2b-256 92b4da3ee2a6e79933bd935d27676cfc471dbb3678d425cc912f0d079ff675fd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page