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.7.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.7-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyoverseerrcontinued-0.0.7.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.7.tar.gz
Algorithm Hash digest
SHA256 0bd16d85ecc8c7deeb930c1b40852f55b79b1d0b12a25bee35df4cc6422b9941
MD5 1f280e970b40ac8c595e5059d905d913
BLAKE2b-256 72f3ce9d16fd0f111c2afc4dcf9b25b30b0534057b1cb3d378d56e7044143ffd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyoverseerrcontinued-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e935cdfae4ec79b62049b3410a9d5e667df27ace47ab0b6c44fcd3f403c6c0d7
MD5 e6100cc262f100b09e8902ede1dea7c5
BLAKE2b-256 7850f68b4d3124d546e0add7ed46dd59df41f9214b184bfd182b03d002ff3ea2

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