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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyoverseerrcontinued-0.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 eb1eee882e2a437d15eaa6c422f5dda5d0e1a88a1001ef049f7b603b1339cd46
MD5 8a44fe5025a45f72638ed6a195b1782f
BLAKE2b-256 53dbe77cb8512096a0f950f15a868b90808036c67204303957f30566568e1054

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyoverseerrcontinued-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8e81a3c65185f031bc0bb6fd63898ba648fd369201c1702407b3cef8d9683113
MD5 ddc6b96302c5eddff203e173f858130a
BLAKE2b-256 75930710098986be21f3a92b9584e8943b9826ba6d5ad87596fd2276e4973cb7

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