# aiopyarr
[](https://codecov.io/gh/tkdrob/aiopyarr)
[](https://pypi.org/project/aiopyarr)
_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
Raw data
{
"_id": null,
"home_page": "https://github.com/tkdrob/aiopyarr",
"name": "aiopyarr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "aiopyarr,radarr,sonarr,plex",
"author": "Robert Hillis",
"author_email": "tkdrob4390@yahoo.com",
"download_url": "https://files.pythonhosted.org/packages/e6/c7/35fe34baeb662e403768d9bd46e831ffe6a07f749477c438369ddf8ba306/aiopyarr-23.4.0.tar.gz",
"platform": null,
"description": "# aiopyarr\n\n[](https://codecov.io/gh/tkdrob/aiopyarr)\n\n[](https://pypi.org/project/aiopyarr)\n\n\n_Python API client for Lidarr/Radarr/Readarr/Sonarr._\n\n## Installation\n\n```bash\npython3 -m pip install aiopyarr\n```\n\n## Example usage\n\nMore examples can be found in the `tests` directory.\n\n```python\n\"\"\"Example usage of aiopyarr.\"\"\"\nimport asyncio\nfrom aiopyarr.models.host_configuration import PyArrHostConfiguration\nfrom aiopyarr.radarr_client import RadarrClient\n\nIP = \"192.168.100.3\"\nTOKEN = \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n\n\nasync def async_example():\n \"\"\"Example usage of aiopyarr.\"\"\"\n host_configuration = PyArrHostConfiguration(ipaddress=IP, api_token=TOKEN)\n async with RadarrClient(host_configuration=host_configuration) as client:\n print(await client.async_get_system_status())\n\nasyncio.get_event_loop().run_until_complete(async_example())\n```\n\n## Contribute\n\n**All** contributions are welcome!\n\n1. Fork the repository\n2. Clone the repository locally and open the devcontainer or use GitHub codespaces\n3. Do your changes\n4. Lint the files with `make lint`\n5. Ensure all tests passes with `make test`\n6. Ensure 100% coverage with `make coverage`\n7. Commit your work, and push it to GitHub\n8. Create a PR against the `master` branch\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "An Asynchronous Lidarr, Radarr, Readarr, Sonarr APIs for Python.",
"version": "23.4.0",
"split_keywords": [
"aiopyarr",
"radarr",
"sonarr",
"plex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1145ddab652b20d3ad7398e058b26f95094aef1573bc4f49e94f789a72a93a80",
"md5": "27e3a9fc8e17302ab8ce7a39267b522f",
"sha256": "d5a3bf882ea0032b5fc2c9977eb85c3d1c3aa8ae11e9afe80fd699d437b8602d"
},
"downloads": -1,
"filename": "aiopyarr-23.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "27e3a9fc8e17302ab8ce7a39267b522f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 69710,
"upload_time": "2023-04-09T01:01:01",
"upload_time_iso_8601": "2023-04-09T01:01:01.614494Z",
"url": "https://files.pythonhosted.org/packages/11/45/ddab652b20d3ad7398e058b26f95094aef1573bc4f49e94f789a72a93a80/aiopyarr-23.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e6c735fe34baeb662e403768d9bd46e831ffe6a07f749477c438369ddf8ba306",
"md5": "1aa05d8bc2133fe5a1cedfbd2edfaf76",
"sha256": "e46151e099f4dea5de8e7c3b0a4832416b9dc2c382c36d7f845e1a5a8064d7b9"
},
"downloads": -1,
"filename": "aiopyarr-23.4.0.tar.gz",
"has_sig": false,
"md5_digest": "1aa05d8bc2133fe5a1cedfbd2edfaf76",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 57263,
"upload_time": "2023-04-09T01:01:03",
"upload_time_iso_8601": "2023-04-09T01:01:03.396206Z",
"url": "https://files.pythonhosted.org/packages/e6/c7/35fe34baeb662e403768d9bd46e831ffe6a07f749477c438369ddf8ba306/aiopyarr-23.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-09 01:01:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "tkdrob",
"github_project": "aiopyarr",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "aiopyarr"
}
JSON
