Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/totaldebug/pyarr

Python client for Servarr API's (Sonarr, Radarr, Readarr, Lidarr)
https://github.com/totaldebug/pyarr

api-wrapper lidarr python radarr readarr sonarr

Last synced: 9 days ago
JSON representation

Python client for Servarr API's (Sonarr, Radarr, Readarr, Lidarr)

Host: GitHub
URL: https://github.com/totaldebug/pyarr
Owner: totaldebug
License: mit
Created: 2020-04-16T10:13:46.000Z (over 4 years ago)
Default Branch: beta
Last Pushed: 2024-06-06T07:49:20.000Z (6 months ago)
Last Synced: 2024-11-03T22:08:30.604Z (17 days ago)
Topics: api-wrapper, lidarr, python, radarr, readarr, sonarr
Language: Python
Homepage: https://docs.totaldebug.uk/pyarr
Size: 10.1 MB
Stars: 72
Watchers: 4
Forks: 19
Open Issues: 16
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.rst
- License: LICENSE

Awesome Lists containing this project

README

        

[![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]






  

    

  

  
Pyarr


  


    A Python library for interacting with the `arr` API's

  

    


    


    Report Bug

    ·

    Request Feature



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    Getting Started

    Features

    Compatibility

    Roadmap

    Sponsor

    Contributing

    License

    Contact

    Acknowledgments

  


## 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.

(back to top)


### Built With

[![python][python]][python-url]

(back to top)


## 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)

(back to top)


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

(back to top)


## Roadmap

See the [feature requests](https://github.com/totaldebug/pyarr/labels/type%2Ffeature) for a full list of requested features.

(back to top)


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

Got something you would like to add? check out the contributing guide in the [documentation](https://docs.totaldebug.uk/pyarr/contributing.html)

(back to top)


## License

[![CC BY-NC-SA 4.0][license-shield]][license-url]

* Copyright © [Total Debug](https://totaldebug.uk).

(back to top)


## Contact

* [Discord](https://discord.gg/6fmekudc8Q)

* [Discussions](https://github.com/totaldebug/pyarr/discussions)

* [Project Link](https://github.com/totaldebug/pyarr)

(back to top)


## Acknowledgments

Below are a list of resources that I used to assist with this project.

* None at this time

(back to top)


[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/