Git Product home page Git Product logo

pyarr's Introduction

Pyarr: Sonarr and Radarr API Python Wrapper

AboutInstallContributeAuthorSupportDonateFull Documentation


About

Pyarr is a high quality Python API Wrapper that provides access to both Radarr and Sonarr REST APIs.

Install

This package is distributed on PyPI and can be installed with pip:

$ pip install pyarr

To use the package in your Python project, you will need to add the following:

from pyarr import SonarrAPI
from pyarr import RadarrAPI

For more information read the full documentation on installing the package

Example Sonarr Usage:

# Import SonarrAPI Class
from pyarr import SonarrAPI

# Set Host URL and API-Key
host_url = 'http://your-domain.com'

# You can find your API key in Settings > General.
api_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

# Instantiate SonarrAPI Object
sonarr = SonarrAPI(host_url, api_key)

# Get and print TV Shows
print(sonarr.get_series())

Example Radarr API Usage:

# Import RadarrAPI Class
from pyarr import RadarrAPI

# Set Host URL and API-Key
host_url = 'http://your-domain.com'

# You can find your API key in Settings > General.
api_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

# Instantiate RadarrAPI Object
radarr = RadarrAPI(host_url, api_key)

# Get and print TV Shows
print(radarr.get_root_folder())

Contribute

Got something interesting you'd like to share? Learn about contributing in our contributing guide.

Author

TotalDebug
marksie1988 (Steven Marks)

Credits

  • Archmonger Some excellent contribution and improvements.

Support

Reach out to me at one of the following places:

Donate

Please consider supporting this project by sponsoring, or just donating a little via our sponsor page.

License

License: CC BY-NC-SA 4.0

pyarr's People

Contributors

archmonger avatar m0thm4n avatar marksie1988 avatar shadowjonathan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.