<a name="readme-top"></a>
[![Release][release-shield]][release-url]
[![Stargazers][stars-shield]][stars-url]
![codecov][codecov-shield]
![GitHub last release date][gh-last-release-date]
![GitHub last commit][gh-last-commit]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Issues][issues-shield]][issues-url]
[![Lines of code][lines]][lines-url]
![Code size][code-size]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/totaldebug/pyarr">
<img src=".github/img/logo.png" alt="Logo">
</a>
<h3 align="center">Pyarr</h3>
<p align="center">
A Python library for interacting with the `arr` API's
</p>
<br />
<br />
<a href="https://github.com/totaldebug/pyarr/issues/new?assignees=&labels=type%2Fbug&template=bug_report.yml">Report Bug</a>
·
<a href="https://github.com/totaldebug/pyarr/issues/new?assignees=&labels=type%2Ffeature&template=feature_request.yml">Request Feature</a>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li><a href="#getting-started">Getting Started</a></li>
<li><a href="#features">Features</a></li>
<li><a href="#compatibility">Compatibility</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#sponsor">Sponsor</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
A Python library for the following `arr` API's:
* Sonarr
* Radarr
* Readarr
* Lidarr
The library returns results in JSON format for ease of use, this also reduces the risk of failue when the arr APIs are updated.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Built With
[![python][python]][python-url]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
* [QuickStart Guide](https://docs.totaldebug.uk/pyarr/quickstart.html)
* [Full Documentation](https://docs.totaldebug.uk/pyarr)
* [Release Notes](https://github.com/totaldebug/pyarr/releases)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Features
* Support for multiple Arr APIs
* Sonarr
* Radarr
* Readarr
* Lidarr
* Type checking
## Compatibility
The below versions are based on our last tests, This will be updated as tests fail and updates are published.
| Version | Sonarr | Radarr | Readarr | Lidarr |
| ------- | ------ | ------ | ------- | ------ |
| v5.0.0 | from: v3.0.10.1567 | from: v4.3.2.6857 | from: v0.1.4.1596 | from: v1.0.2.2592 |
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ROADMAP -->
## Roadmap
See the [feature requests](https://github.com/totaldebug/pyarr/labels/type%2Ffeature) for a full list of requested features.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Sponsor
My projects arent possible without the support of the community, please consider donating a small amount to keep these projects alive.
[![Sponsor][Sponsor]][Sponsor-url]
<!-- CONTRIBUTING -->
## Contributing
Got something you would like to add? check out the contributing guide in the [documentation](https://docs.totaldebug.uk/pyarr/contributing.html)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## License
[![CC BY-NC-SA 4.0][license-shield]][license-url]
* Copyright © [Total Debug](https://totaldebug.uk).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
* [Discord](https://discord.gg/6fmekudc8Q)
* [Discussions](https://github.com/totaldebug/pyarr/discussions)
* [Project Link](https://github.com/totaldebug/pyarr)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
Below are a list of resources that I used to assist with this project.
* None at this time
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[release-shield]: https://img.shields.io/github/v/release/totaldebug/pyarr?color=ff7034&label=Release&sort=semver&style=flat-square
[release-url]: https://github.com/totaldebug/pyarr/releases
[contributors-shield]: https://img.shields.io/github/contributors/totaldebug/pyarr.svg?style=flat-square
[contributors-url]: https://github.com/totaldebug/pyarr/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/totaldebug/pyarr.svg?style=flat-square
[forks-url]: https://github.com/totaldebug/pyarr/network/members
[stars-shield]: https://img.shields.io/github/stars/totaldebug/pyarr.svg?style=flat-square
[stars-url]: https://github.com/totaldebug/pyarr/stargazers
[issues-shield]: https://img.shields.io/github/issues/totaldebug/pyarr.svg?style=flat-square
[issues-url]: https://github.com/totaldebug/pyarr/issues
[license-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-orange.svg?style=flat-square
[license-url]: https://creativecommons.org/licenses/by-nc-sa/4.0/
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/marksie1988
[codecov-shield]: https://img.shields.io/codecov/c/github/totaldebug/pyarr?style=flat-square
[gh-last-release-date]: https://img.shields.io/github/release-date/totaldebug/pyarr?style=flat-square&label=Last%20Release%20Date&logo=github&logoColor=white
[gh-last-commit]: https://img.shields.io/github/last-commit/totaldebug/pyarr.svg?style=flat-square&logo=github&label=Last%20Commit&logoColor=white
[lines]: https://img.shields.io/tokei/lines/github/totaldebug/pyarr?style=flat-square
[lines-url]: https://github.com/totaldebug/pyarr
[code-size]: https://img.shields.io/github/languages/code-size/totaldebug/pyarr?style=flat-square
[Sponsor]: https://img.shields.io/badge/sponsor-000?style=flat-square&logo=githubsponsors&logoColor=red
[Sponsor-url]: https://github.com/sponsors/marksie1988
[python]: https://img.shields.io/badge/Python-blue?style=flat-square&logo=Python&logoColor=white
[python-url]: https://www.python.org/
Raw data
{
"_id": null,
"home_page": "https://github.com/totaldebug/pyarr",
"name": "pyarr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "sonarr,radarr,readarr,lidarr,api,wrapper,plex",
"author": "Steven Marks",
"author_email": "marksie1988@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/d7/dc/3df29efc72a53cad21de33e84144822ddfdbdd68127df6c577a187313de9/pyarr-5.2.0.tar.gz",
"platform": null,
"description": "<a name=\"readme-top\"></a>\n\n[![Release][release-shield]][release-url]\n[![Stargazers][stars-shield]][stars-url]\n![codecov][codecov-shield]\n\n![GitHub last release date][gh-last-release-date]\n![GitHub last commit][gh-last-commit]\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Issues][issues-shield]][issues-url]\n\n[![Lines of code][lines]][lines-url]\n![Code size][code-size]\n\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n<!-- PROJECT LOGO -->\n<br />\n<div align=\"center\">\n <a href=\"https://github.com/totaldebug/pyarr\">\n <img src=\".github/img/logo.png\" alt=\"Logo\">\n </a>\n\n <h3 align=\"center\">Pyarr</h3>\n\n <p align=\"center\">\n A Python library for interacting with the `arr` API's\n </p>\n <br />\n <br />\n <a href=\"https://github.com/totaldebug/pyarr/issues/new?assignees=&labels=type%2Fbug&template=bug_report.yml\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/totaldebug/pyarr/issues/new?assignees=&labels=type%2Ffeature&template=feature_request.yml\">Request Feature</a>\n\n</div>\n\n<!-- TABLE OF CONTENTS -->\n<details>\n <summary>Table of Contents</summary>\n <ol>\n <li>\n <a href=\"#about-the-project\">About The Project</a>\n <ul>\n <li><a href=\"#built-with\">Built With</a></li>\n </ul>\n </li>\n <li><a href=\"#getting-started\">Getting Started</a></li>\n <li><a href=\"#features\">Features</a></li>\n <li><a href=\"#compatibility\">Compatibility</a></li>\n <li><a href=\"#roadmap\">Roadmap</a></li>\n <li><a href=\"#sponsor\">Sponsor</a></li>\n <li><a href=\"#contributing\">Contributing</a></li>\n <li><a href=\"#license\">License</a></li>\n <li><a href=\"#contact\">Contact</a></li>\n <li><a href=\"#acknowledgments\">Acknowledgments</a></li>\n </ol>\n</details>\n\n<!-- ABOUT THE PROJECT -->\n## About The Project\n\nA Python library for the following `arr` API's:\n\n* Sonarr\n* Radarr\n* Readarr\n* Lidarr\n\nThe library returns results in JSON format for ease of use, this also reduces the risk of failue when the arr APIs are updated.\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n### Built With\n\n[![python][python]][python-url]\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n<!-- GETTING STARTED -->\n## Getting Started\n\n* [QuickStart Guide](https://docs.totaldebug.uk/pyarr/quickstart.html)\n* [Full Documentation](https://docs.totaldebug.uk/pyarr)\n* [Release Notes](https://github.com/totaldebug/pyarr/releases)\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n## Features\n\n* Support for multiple Arr APIs\n* Sonarr\n* Radarr\n* Readarr\n* Lidarr\n* Type checking\n\n## Compatibility\n\nThe below versions are based on our last tests, This will be updated as tests fail and updates are published.\n\n| Version | Sonarr | Radarr | Readarr | Lidarr |\n| ------- | ------ | ------ | ------- | ------ |\n| v5.0.0 | from: v3.0.10.1567 | from: v4.3.2.6857 | from: v0.1.4.1596 | from: v1.0.2.2592 |\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n<!-- ROADMAP -->\n## Roadmap\n\nSee the [feature requests](https://github.com/totaldebug/pyarr/labels/type%2Ffeature) for a full list of requested features.\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n## Sponsor\n\nMy projects arent possible without the support of the community, please consider donating a small amount to keep these projects alive.\n\n[![Sponsor][Sponsor]][Sponsor-url]\n\n<!-- CONTRIBUTING -->\n## Contributing\n\nGot something you would like to add? check out the contributing guide in the [documentation](https://docs.totaldebug.uk/pyarr/contributing.html)\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n<!-- LICENSE -->\n## License\n\n[![CC BY-NC-SA 4.0][license-shield]][license-url]\n\n* Copyright \u00a9 [Total Debug](https://totaldebug.uk).\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n<!-- CONTACT -->\n## Contact\n\n* [Discord](https://discord.gg/6fmekudc8Q)\n* [Discussions](https://github.com/totaldebug/pyarr/discussions)\n* [Project Link](https://github.com/totaldebug/pyarr)\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n<!-- ACKNOWLEDGMENTS -->\n## Acknowledgments\n\nBelow are a list of resources that I used to assist with this project.\n\n* None at this time\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n<!-- MARKDOWN LINKS & IMAGES -->\n<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->\n[release-shield]: https://img.shields.io/github/v/release/totaldebug/pyarr?color=ff7034&label=Release&sort=semver&style=flat-square\n[release-url]: https://github.com/totaldebug/pyarr/releases\n[contributors-shield]: https://img.shields.io/github/contributors/totaldebug/pyarr.svg?style=flat-square\n[contributors-url]: https://github.com/totaldebug/pyarr/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/totaldebug/pyarr.svg?style=flat-square\n[forks-url]: https://github.com/totaldebug/pyarr/network/members\n[stars-shield]: https://img.shields.io/github/stars/totaldebug/pyarr.svg?style=flat-square\n[stars-url]: https://github.com/totaldebug/pyarr/stargazers\n[issues-shield]: https://img.shields.io/github/issues/totaldebug/pyarr.svg?style=flat-square\n[issues-url]: https://github.com/totaldebug/pyarr/issues\n[license-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-orange.svg?style=flat-square\n[license-url]: https://creativecommons.org/licenses/by-nc-sa/4.0/\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555\n[linkedin-url]: https://linkedin.com/in/marksie1988\n[codecov-shield]: https://img.shields.io/codecov/c/github/totaldebug/pyarr?style=flat-square\n\n[gh-last-release-date]: https://img.shields.io/github/release-date/totaldebug/pyarr?style=flat-square&label=Last%20Release%20Date&logo=github&logoColor=white\n[gh-last-commit]: https://img.shields.io/github/last-commit/totaldebug/pyarr.svg?style=flat-square&logo=github&label=Last%20Commit&logoColor=white\n\n[lines]: https://img.shields.io/tokei/lines/github/totaldebug/pyarr?style=flat-square\n[lines-url]: https://github.com/totaldebug/pyarr\n[code-size]: https://img.shields.io/github/languages/code-size/totaldebug/pyarr?style=flat-square\n\n[Sponsor]: https://img.shields.io/badge/sponsor-000?style=flat-square&logo=githubsponsors&logoColor=red\n[Sponsor-url]: https://github.com/sponsors/marksie1988\n\n[python]: https://img.shields.io/badge/Python-blue?style=flat-square&logo=Python&logoColor=white\n[python-url]: https://www.python.org/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Synchronous Sonarr, Radarr, Lidarr and Readarr API's for Python",
"version": "5.2.0",
"project_urls": {
"Documentation": "https://docs.totaldebug.uk/pyarr",
"Homepage": "https://github.com/totaldebug/pyarr",
"Repository": "https://github.com/totaldebug/pyarr"
},
"split_keywords": [
"sonarr",
"radarr",
"readarr",
"lidarr",
"api",
"wrapper",
"plex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6a7b703551fae52e6b2e3976f9dfb6c85d2226d523179f2d18bc6721cac6fb3d",
"md5": "6993e1317bd27e7f0818c606f379349f",
"sha256": "003e2c40183e97afc8a3da511573c25a3e8d7a9cb36ab28c0a678daeb706bcd4"
},
"downloads": -1,
"filename": "pyarr-5.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6993e1317bd27e7f0818c606f379349f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 39607,
"upload_time": "2023-07-28T14:51:53",
"upload_time_iso_8601": "2023-07-28T14:51:53.389624Z",
"url": "https://files.pythonhosted.org/packages/6a/7b/703551fae52e6b2e3976f9dfb6c85d2226d523179f2d18bc6721cac6fb3d/pyarr-5.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d7dc3df29efc72a53cad21de33e84144822ddfdbdd68127df6c577a187313de9",
"md5": "f911b23a07e18f9688954e0abc7c6478",
"sha256": "8e571cf4a8f53184ac9ef2642995d75962550f1dca22ea238db1ad97c903529c"
},
"downloads": -1,
"filename": "pyarr-5.2.0.tar.gz",
"has_sig": false,
"md5_digest": "f911b23a07e18f9688954e0abc7c6478",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 35344,
"upload_time": "2023-07-28T14:51:54",
"upload_time_iso_8601": "2023-07-28T14:51:54.483091Z",
"url": "https://files.pythonhosted.org/packages/d7/dc/3df29efc72a53cad21de33e84144822ddfdbdd68127df6c577a187313de9/pyarr-5.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-28 14:51:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "totaldebug",
"github_project": "pyarr",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pyarr"
}
JSON
