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 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.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyoverseerrcontinued-0.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 b56f1c8eae941384c2e54701c32f76f2ad6b35f5e5e3e8a245f044b685c31494
MD5 c4c94ce2dfa67224d41a2b965c219281
BLAKE2b-256 734c82339a3f70db5ae287e08ae76c842dda15b6fca941a9d4b9c36182048628

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyoverseerrcontinued-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f84b0eb110fa29a33d748b78b7fc157a4856c45e4e51fbfa3b9d6f6b2ca1c78b
MD5 9e15a3dec72a199b4d5b765dd2548670
BLAKE2b-256 f3c5cbe2351105467e9c2ebbd5338fac7a581f1ca63238c7f96e225e6dd0f2dd

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