Metadata-Version: 2.1
Name: pyarr
Version: 1.0.1
Summary: A Sonarr and Radarr API Wrapper
Home-page: https://github.com/totaldebug/pyarr
License: MIT
Keywords: sonarr,radarr,api,wrapper
Author: Steven Marks
Author-email: marksie1988@users.noreply.github.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: requests (>=2.21.0,<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

Unofficial Python Wrapper for the [Sonarr](https://github.com/Sonarr/Sonarr) and [Radarr](https://github.com/Radarr/Radarr) API.

Now supports Radarr v3 API


Based on the origional wrapper from [SLiX69/Sonarr-API-Python-Wrapper](https://github.com/SLiX69/Sonarr-API-Python-Wrapper).

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

### Requirements

- requests

### Example Sonarr Usage:

```
# 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.getSeries())
```

### Example Radarr API v1 Usage:

```
# Import RadarrAPI Class
from pyarr import RadarrAPIv1

# 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 = RadarrAPIv1(host_url, api_key)

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

### Documentation

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

