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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyoverseerrcontinued-0.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 fb4d93eaec59704043de0baa0aa00e5e6749a1ab73bb3cc058b59b5d8562a203
MD5 ee855f045c901ae1047df4a046a8d690
BLAKE2b-256 aa66755f4a525c24f0725c1dea1c198712a2a4409a5481c46bc4781f278b9918

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyoverseerrcontinued-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8b4249e1c7c6e3ebff3d3985d89bb7e7fb906b0a86d8c1fcfe9ffbe16016df98
MD5 b594e5c37dbf46c55f94e3f537690be2
BLAKE2b-256 3e7c4e6522da3b185e4253aa5da05d57724e22c90481576f8062f7c4fdcaa583

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