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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyoverseerrcontinued-0.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 a05694ac2e0ebd8191a460809b49f400ed7a90ccb3b7ec754f547ffe390f40e5
MD5 8b3a7970f373886f5fe5772bdcf26e8e
BLAKE2b-256 121ddc1a774e600aaadebdc6844b24deb2db21645ca2358804d34b9eb1d4aa1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyoverseerrcontinued-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0cc2c37ec89e1301dbaf2e992c6c25d2266f49314a55a5807d567cb24a93bf23
MD5 81614d9f00208e3bc5338777e0f18c8a
BLAKE2b-256 84793863bade789867c88d5331dbf0834edfd6b1595c344fd851fdccbf84bd13

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