https://github.com/tkdrob/aiopyarr

Python API client for Lidarr/Radarr/Readarr/Sonarr.
https://github.com/tkdrob/aiopyarr

aiohttp asyncio lidarr plex pyarr python python3 radarr readarr rest-api sonarr

Last synced: about 16 hours ago
JSON representation

Python API client for Lidarr/Radarr/Readarr/Sonarr.

• Host: GitHub
• URL: https://github.com/tkdrob/aiopyarr
• Owner: tkdrob
• License: mit
• Created: 2021-11-30T14:28:55.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-07T15:17:51.000Z (over 1 year ago)
• Last Synced: 2025-12-22T01:36:30.278Z (4 months ago)
• Topics: aiohttp, asyncio, lidarr, plex, pyarr, python, python3, radarr, readarr, rest-api, sonarr
• Language: Python
• Homepage:
• Size: 1 MB
• Stars: 19
• Watchers: 1
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# aiopyarr

[![codecov](https://codecov.io/gh/tkdrob/aiopyarr/branch/master/graph/badge.svg)](https://codecov.io/gh/tkdrob/aiopyarr)

![python version](https://img.shields.io/badge/Python-3.9=><=3.12-blue.svg)

[![PyPI](https://img.shields.io/pypi/v/aiopyarr)](https://pypi.org/project/aiopyarr)

![Actions](https://github.com/tkdrob/aiopyarr/workflows/Actions/badge.svg?branch=master)

_Python API client for Lidarr/Radarr/Readarr/Sonarr._

## Installation

```bash

python3 -m pip install aiopyarr

```

## Example usage

More examples can be found in the `tests` directory.

```python

"""Example usage of aiopyarr."""

import asyncio

from aiopyarr.models.host_configuration import PyArrHostConfiguration

from aiopyarr.radarr_client import RadarrClient

IP = "192.168.100.3"

TOKEN = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

async def async_example():

    """Example usage of aiopyarr."""

    host_configuration = PyArrHostConfiguration(ipaddress=IP, api_token=TOKEN)

    async with RadarrClient(host_configuration=host_configuration) as client:

        print(await client.async_get_system_status())

asyncio.get_event_loop().run_until_complete(async_example())

```

## Contribute

**All** contributions are welcome!

1. Fork the repository

2. Clone the repository locally and open the devcontainer or use GitHub codespaces

3. Do your changes

4. Lint the files with `make lint`

5. Ensure all tests passes with `make test`

6. Ensure 100% coverage with `make coverage`

7. Commit your work, and push it to GitHub

8. Create a PR against the `master` branch