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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyoverseerrcontinued-0.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 d57c5518dda501971af08f877977384b765b5b2a5323c82abff85069ae7cca51
MD5 2e9eb0d2255d6e512eef0aaced7670db
BLAKE2b-256 21fbf427ac1f863bb7747599a614c46c618457ca59e0c68d4d2d69fbcce95c5c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyoverseerrcontinued-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9dfd09fa725518bbbb099be409f73f675f49be9bfdcedb6596b5e64565caf9aa
MD5 617da136634f9890e113efbaebfd0758
BLAKE2b-256 cfe04c66ed59fc618957faa18c2f731c25ab39eb567ca8b5134c4a9a71b96e13

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