Metadata-Version: 2.1
Name: pyarr
Version: 3.1.3
Summary: Python client for Servarr API's (Sonarr, Radarr, Readarr)
Home-page: https://github.com/totaldebug/pyarr
License: MIT
Keywords: sonarr,radarr,readarr,api,wrapper
Author: Steven Marks
Author-email: marksie1988@users.noreply.github.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: requests (>=2.21.0,<3.0.0)
Requires-Dist: types-requests (>=2.25.11,<3.0.0)
Project-URL: Documentation, https://docs.totaldebug.uk/pyarr
Project-URL: Repository, https://github.com/totaldebug/pyarr
Description-Content-Type: text/markdown

# Sonarr and Radarr API Python Wrapper

Python Wrapper for the [Sonarr](https://github.com/Sonarr/Sonarr), [Radarr](https://github.com/Radarr/Radarr), [Lidarr](https://github.com/Lidarr/Lidarr) & [Readarr](https://github.com/Readarr/Readarr) API.

See the full [documentation](https://docs.totaldebug.uk/pyarr/) for supported functions.

### Requirements

-   requests

### Example Sonarr Usage:

```python
# Import SonarrAPI Class
from pyarr import SonarrAPI

# Set Host URL and API-Key
host_url = 'http://your-domain.com'

# You can find your API key in Settings > General.
api_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

# Instantiate SonarrAPI Object
sonarr = SonarrAPI(host_url, api_key)

# Get and print TV Shows
print(sonarr.get_series(123))
```

### Example Radarr Usage:

```python
# Import RadarrAPI Class
from pyarr import RadarrAPI

# Set Host URL and API-Key
host_url = 'http://your-domain.com'

# You can find your API key in Settings > General.
api_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

# Instantiate RadarrAPI Object
radarr = RadarrAPI(host_url, api_key)

# Get and print TV Shows
print(radarr.get_root_folder())
```

### Documentation

-   [Pyarr Documentation](https://docs.totaldebug.uk/pyarr)
-   [Sonarr API Documentation](https://github.com/Sonarr/Sonarr/wiki/API)
-   [Radarr API Documentation](https://radarr.video/docs/api)

