Metadata-Version: 2.4
Name: pyoverseerrcontinued
Version: 0.0.9
Summary: A python module to retrieve information from Overseerr. Continued!
Author-email: Henry Hochleutner <henryhochleutner@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/hhochdev/pyoverseerrContinued
Project-URL: Issues, https://github.com/hhochdev/pyoverseerrContinued/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: logging
Requires-Dist: requests
Dynamic: license-file

[![PyPI version](https://badge.fury.io/py/pyoverseerrcontinued.svg)](https://badge.fury.io/py/pyoverseerrcontinued)

# pyoverseerr

This is a project for retrieving information from an Overseerr instance using their API.


# Installation

Run the following to install:
```python
pip install pyoverseerrcontinued
```


# Usage


#### Creating an object of your Overseerr instance

**Note:** You have to supply an `api_key` to successfully authenticate.

```python
import pyoverseerr

overseerr = pyoverseerr.Overseerr(
    url="192.168.1.120:5055",
    api_key="pixf64thuh2m7kbwwgkqp52yznbj4oyo"
)
```

#### Authenticate

```python
overseerr.authenticate()
```

#### Testing connection to Overseerr

```python
try:
    overseerr.test_connection()
except pyoverseerr.OverseerrError as e:
    print(e)
    return
```

#### Retrieving data
```python
movies = overseerr.movie_requests
tv = overseerr.tv_requests
music = overseerr.music_requests

total = overseerr.total_requests
```

#### Searching

```python
# 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
```python
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.
