Skip to main content

An Asynchronous Lidarr, Radarr, Readarr, Sonarr APIs for Python.

Project description

aiopyarr

codecov python version PyPI Actions

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

Installation

python3 -m pip install aiopyarr

Example usage

More examples can be found in the tests directory.

"""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

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

aiopyarr-23.4.0.tar.gz (57.3 kB view details)

Uploaded Source

Built Distribution

aiopyarr-23.4.0-py3-none-any.whl (69.7 kB view details)

Uploaded Python 3

File details

Details for the file aiopyarr-23.4.0.tar.gz.

File metadata

  • Download URL: aiopyarr-23.4.0.tar.gz
  • Upload date:
  • Size: 57.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for aiopyarr-23.4.0.tar.gz
Algorithm Hash digest
SHA256 e46151e099f4dea5de8e7c3b0a4832416b9dc2c382c36d7f845e1a5a8064d7b9
MD5 1aa05d8bc2133fe5a1cedfbd2edfaf76
BLAKE2b-256 e6c735fe34baeb662e403768d9bd46e831ffe6a07f749477c438369ddf8ba306

See more details on using hashes here.

File details

Details for the file aiopyarr-23.4.0-py3-none-any.whl.

File metadata

  • Download URL: aiopyarr-23.4.0-py3-none-any.whl
  • Upload date:
  • Size: 69.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for aiopyarr-23.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d5a3bf882ea0032b5fc2c9977eb85c3d1c3aa8ae11e9afe80fd699d437b8602d
MD5 27e3a9fc8e17302ab8ce7a39267b522f
BLAKE2b-256 1145ddab652b20d3ad7398e058b26f95094aef1573bc4f49e94f789a72a93a80

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page