Skip to main content

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.

Metadata

Release files for pyoverseerr 0.1.40

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyoverseerr 0.1.40
File Size Uploaded Provenance
pyoverseerr-0.1.40.tar.gz 5.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pyoverseerr 0.1.40
File Interpreter ABI Platform
pyoverseerr-0.1.40-py3-none-any.whl Python 3 none any Details

Total release size: 10.4 kB

Release files / pyoverseerr-0.1.40.tar.gz

Download URL pyoverseerr-0.1.40.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
e7b47d3910f864c4e0caafe640c0c061234f09a161d3a5a46a948fe4468c3ea0
BLAKE2b-256 checksum
How to use checksums
4e1216961f9dbb54a3fd55c6b4fa04ad81af624fc0224edf4ada29be4f13dca5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.5

Release files / pyoverseerr-0.1.40-py3-none-any.whl

Download URL pyoverseerr-0.1.40-py3-none-any.whl
Size 5.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
207c46373e1a52a47093ef40a7747c7b3aea1b8e41f045b653b96b7786dffe49
BLAKE2b-256 checksum
How to use checksums
f7e7c2e970b47af9d2d1ba1fa3995aec1b4cfb37a2de9bb3b450c16d2bb6d93b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.5

Security for pyoverseerr 0.1.40

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page