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.8.tar.gz (5.2 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.8-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyoverseerrcontinued-0.0.8.tar.gz
  • Upload date:
  • Size: 5.2 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.8.tar.gz
Algorithm Hash digest
SHA256 687f708ff0339e02ec4bc318bb2b26dde8c596908a6503293caece05c285b4e2
MD5 f81dd4f6f93ab114862934f466a048b7
BLAKE2b-256 26fb1d673a474ab550d35dd50aa1d840e422b78aa746439d8e9f19c5de363331

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyoverseerrcontinued-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 97ae2786af1603f4f1034c913178356232c5a6dbaa863b253c21f360d5dceb24
MD5 c522120712af50bd17ac44a10feeb947
BLAKE2b-256 22d360a94d34df801781e60f4a8e0c1bed378b283636c878a054ffa8ddbdee94

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