arrapi


Namearrapi JSON
Version 1.4.13 PyPI version JSON
download
home_pagehttps://github.com/Kometa-Team/ArrAPI
SummaryPython wrapper for Radarr and Sonarr APIs:
upload_time2024-04-25 06:21:54
maintainerNone
docs_urlNone
authorNathan Taggart
requires_python>=3.8
licenseMIT License
keywords arrapi sonarr radarr arr wrapper api
VCS
bugtrack_url
requirements requests setuptools
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ArrAPI
==========================================================

.. image:: https://img.shields.io/github/v/release/Kometa-Team/ArrAPI?style=plastic
    :target: https://github.com/Kometa-Team/ArrAPI/releases
    :alt: GitHub release (latest by date)

.. image:: https://img.shields.io/travis/com/Kometa-Team/ArrAPI?style=plastic
    :target: https://app.travis-ci.com/Kometa-Team/ArrAPI
    :alt: Build Testing

.. image:: https://img.shields.io/github/commits-since/Kometa-Team/ArrAPI/latest?style=plastic
    :target: https://github.com/Kometa-Team/ArrAPI/commits/master
    :alt: GitHub commits since latest release (by date) for a branch

.. image:: https://img.shields.io/pypi/v/ArrAPI?style=plastic
    :target: https://pypi.org/project/arrapi/
    :alt: PyPI

.. image:: https://img.shields.io/pypi/dm/arrapi.svg?style=plastic
    :target: https://pypi.org/project/arrapi/
    :alt: Downloads

|

.. image:: https://img.shields.io/readthedocs/arrapi?style=plastic
    :target: https://arrapi.kometa.wiki
    :alt: Wiki

.. image:: https://img.shields.io/discord/822460010649878528?color=%2300bc8c&label=Discord&style=plastic
    :target: https://kometa.wiki/en/latest/discord/
    :alt: Discord

.. image:: https://img.shields.io/reddit/subreddit-subscribers/Kometa?color=%2300bc8c&label=r%2FKometa&style=plastic
    :target: https://www.reddit.com/r/Kometa/
    :alt: Reddit

.. image:: https://img.shields.io/github/sponsors/meisnate12?color=%238a2be2&style=plastic
    :target: https://github.com/sponsors/meisnate12
    :alt: GitHub Sponsors

.. image:: https://img.shields.io/badge/-Sponsor_or_Donate-blueviolet?style=plastic
    :target: https://github.com/sponsors/Kometa-Team
    :alt: Sponsor or Donate

Overview
----------------------------------------------------------
Unofficial Python bindings for the Sonarr and Radarr APIs. The goal is to make interaction with the API as easy as possible while emulating the Web Client as much as possible


Installation & Documentation
----------------------------------------------------------

.. code-block:: python

    pip install arrapi

Documentation_ can be found at Read the Docs.

.. _Documentation: https://arrapi.kometa.wiki

Connecting to Sonarr
==========================================================

Getting a SonarrAPI Instance
----------------------------------------------------------

To connect to a Sonarr application you have to use the |SonarrAPI|_ object and provide it with the ``baseurl`` and ``apikey`` parameters.

The ``apikey`` can be found by going to ``Settings > General > Security > API Key``

.. code-block:: python

    from arrapi import SonarrAPI

    baseurl = "http://192.168.1.12:8989"
    apikey = "0010843563404748808d3fc9c562c05e"

    sonarr = SonarrAPI(baseurl, apikey)

Using the SonarrAPI Instance
----------------------------------------------------------

Once you have a |SonarrAPI|_ instance you can use it to interact with the application.

To add, edit, or delete a singular Series you must first find the |Series|_ object.

Find a Series Object
----------------------------------------------------------

There are three ways to find a |Series|_ object.

You can get a |Series|_ object using |get_series|_ and giving it a ``Sonarr Series ID`` or ``TVDb ID``.

.. code-block:: python

    series = sonarr.get_series(tvdb_id=121361)

You can get a ``List`` of |Series|_ objects using |search_series|_ and giving it a search term.

.. code-block:: python

    search = sonarr.search_series("Game of Thrones")

You can get a ``List`` of all |Series|_ objects in Sonarr using |all_series|_.

.. code-block:: python

    all_series = sonarr.all_series()

Using a Series Object
----------------------------------------------------------

To add a series to Sonarr use |sonarr_add|_.

.. code-block:: python

    series.add("/shows/", "HD-1080p", "English")

To edit a series in Sonarr use |sonarr_edit|_.

.. code-block:: python

    series.edit(tags=["hd"])

To delete a series in Sonarr use |sonarr_delete|_.

.. code-block:: python

    series.delete()

Perform Operations on Multiple Series
----------------------------------------------------------

To add multiple Series to Sonarr use |add_multiple_series|_ with the Series' TVDb IDs.

.. code-block:: python

    series_ids = [83268, 283468, 385376]
    added, exists, invalid = sonarr.add_multiple_series(series_ids, "/shows/", "HD-1080p", "English")

To edit multiple Series in Sonarr use |edit_multiple_series|_ with the Series' TVDb IDs.

.. code-block:: python

    series_ids = [83268, 283468, 385376]
    edited, not_exist = sonarr.edit_multiple_series(series_ids, monitor=False)

To delete multiple Series in Sonarr use |delete_multiple_series|_ with the Series' TVDb IDs.

.. code-block:: python

    series_ids = [83268, 283468, 385376]
    not_exist = sonarr.delete_multiple_series(series_ids)

Respect Sonarr List Exclusions
----------------------------------------------------------

To respect Sonarr's List Exclusions, before running |sonarr_add|_ or |add_multiple_series|_ you can use |sonarr_exclusions|_ like so.

.. code-block:: python

    series_ids = [83268, 283468, 385376]
    sonarr.respect_list_exclusions_when_adding()
    added, exists, invalid = sonarr.add_multiple_series(series_ids, "/shows/", "HD-1080p", "English")

Connecting to Radarr
==========================================================

Getting a RadarrAPI Instance
----------------------------------------------------------

To connect to a Radarr application you have to use the |RadarrAPI|_ object and provide it with the ``baseurl`` and ``apikey`` parameters.

The ``apikey`` can be found by going to ``Settings > General > Security > API Key``

.. code-block:: python

    from arrapi import RadarrAPI

    baseurl = "http://192.168.1.12:8989"
    apikey = "0010843563404748808d3fc9c562c05e"

    radarr = RadarrAPI(baseurl, apikey)

Using the RadarrAPI Instance
----------------------------------------------------------

Once you have a |RadarrAPI|_ instance you can use it to interact with the application.

To add, edit, or delete a singular Movie you must first find the |Movie|_ object.

Find a Movie Object
----------------------------------------------------------

There are three ways to find a |Movie|_ object.

You can get a |Movie|_ object using |get_movie|_ and giving it a ``Radarr Movie ID`` or ``TVDb ID``.

.. code-block:: python

    movie = radarr.get_movie(tmdb_id=121361)

You can get a ``List`` of |Movie|_ objects using |search_movies|_ and giving it a search term.

.. code-block:: python

    search = radarr.search_movies("The Lord of the Rings: The Return of the King")

You can get a ``List`` of all |Movie|_ objects in Radarr using |all_movies|_.

.. code-block:: python

    all_movies = radarr.all_movies()

Using a Movie Object
----------------------------------------------------------

To add a movie to Radarr use |radarr_add|_.

.. code-block:: python

    movie.add("/movies/", "HD-1080p")

To edit a movie in Radarr use |radarr_edit|_.

.. code-block:: python

    movie.edit(tags=["hd"])

To delete a movie in Radarr use |radarr_delete|_.

.. code-block:: python

    movie.delete()

Perform Operations on Multiple Movie
----------------------------------------------------------

To add multiple Movies to Radarr use |add_multiple_movies|_ with the Movie's TMDb IDs.

.. code-block:: python

    movie_ids = [11, 1891, 1892, 1893, 1894, 1895]
    added, exists, invalid = radarr.add_multiple_movies(movie_ids, "/movies/", "HD-1080p")

To edit multiple Movies in Radarr use |edit_multiple_movies|_ with the Movie's TMDb IDs.

.. code-block:: python

    movie_ids = [11, 1891, 1892, 1893, 1894, 1895]
    edited, not_exist = radarr.edit_multiple_movies(movie_ids, monitor=False)

To delete multiple Movies in Radarr use |delete_multiple_movies|_ with the Movie's TMDb IDs.

.. code-block:: python

    movie_ids = [11, 1891, 1892, 1893, 1894, 1895]
    not_exist = radarr.delete_multiple_movies(movie_ids)

Respect Radarr List Exclusions
----------------------------------------------------------

To respect Radarr's List Exclusions, before running |radarr_add|_ or |add_multiple_movies|_ you can use |radarr_exclusions|_ like so.

.. code-block:: python

    movie_ids = [11, 1891, 1892, 1893, 1894, 1895]
    radarr.respect_list_exclusions_when_adding()
    added, exists, invalid = radarr.add_multiple_movies(movie_ids, "/movies/", "HD-1080p")

Usage Examples
==========================================================

Example 1: List all series in Sonarr.

.. code-block:: python

    series = sonarr.all_series()
    for show in series:
        print(show.title)

Example 2: Search for a movie and add it to Radarr by name.

.. code-block:: python

    search = radarr.search_movies("The Lord of the Rings: The Return of the King")
    if search:
        search[0].add("/movies/", "HD-1080p")

Example 3: Make every series in Sonarr Unmonitored.

.. code-block:: python

    edited, not_exist = sonarr.edit_multiple_series(sonarr.all_series(), monitor=False)

Example 4: Get all Quality Profiles Available.

.. code-block:: python

    for qp in sonarr.quality_profile():
        print(qp.name)

Hyperlinks
----------------------------------------------------------

* `Radarr v3 API Docs <https://radarr.video/docs/api>`_
* `Sonarr v3 API Docs <https://sonarr.tv/docs/api/>`_

.. |SonarrAPI| replace:: ``SonarrAPI``
.. _SonarrAPI: https://arrapi.kometa.wiki/en/latest/sonarr.html#module-arrapi.sonarr

.. |Series| replace:: ``Series``
.. _Series: https://arrapi.kometa.wiki/en/latest/objs.html#series

.. |get_series| replace:: ``get_series``
.. _get_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.get_series

.. |search_series| replace:: ``search_series``
.. _search_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.search_series

.. |all_series| replace:: ``all_series``
.. _all_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.all_series

.. |sonarr_add| replace:: ``add``
.. _sonarr_add: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Series.add

.. |sonarr_edit| replace:: ``edit``
.. _sonarr_edit: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Series.edit

.. |sonarr_delete| replace:: ``delete``
.. _sonarr_delete: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Series.delete

.. |add_multiple_series| replace:: ``add_multiple_series``
.. _add_multiple_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.add_multiple_series

.. |edit_multiple_series| replace:: ``edit_multiple_series``
.. _edit_multiple_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.edit_multiple_series

.. |delete_multiple_series| replace:: ``delete_multiple_series``
.. _delete_multiple_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.delete_multiple_series

.. |sonarr_exclusions| replace:: ``sonarr_exclusions``
.. _sonarr_exclusions: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.respect_list_exclusions_when_adding

.. |RadarrAPI| replace:: ``RadarrAPI``
.. _RadarrAPI: https://arrapi.kometa.wiki/en/latest/radarr.html#module-arrapi.radarr

.. |Movie| replace:: ``Movie``
.. _Movie: https://arrapi.kometa.wiki/en/latest/objs.html#movie

.. |get_movie| replace:: ``get_movie``
.. _get_movie: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.get_movie

.. |search_movies| replace:: ``search_movies``
.. _search_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.search_movies

.. |all_movies| replace:: ``all_movies``
.. _all_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.all_movies

.. |radarr_add| replace:: ``add``
.. _radarr_add: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Movie.add

.. |radarr_edit| replace:: ``edit``
.. _radarr_edit: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Movie.edit

.. |radarr_delete| replace:: ``delete``
.. _radarr_delete: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Movie.delete

.. |add_multiple_movies| replace:: ``add_multiple_movies``
.. _add_multiple_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.add_multiple_movies

.. |edit_multiple_movies| replace:: ``edit_multiple_movies``
.. _edit_multiple_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.edit_multiple_movies

.. |delete_multiple_movies| replace:: ``delete_multiple_movies``
.. _delete_multiple_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.delete_multiple_movies

.. |radarr_exclusions| replace:: ``radarr_exclusions``
.. _radarr_exclusions: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.respect_list_exclusions_when_adding

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Kometa-Team/ArrAPI",
    "name": "arrapi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "arrapi, sonarr, radarr, arr, wrapper, api",
    "author": "Nathan Taggart",
    "author_email": "kometateam@proton.me",
    "download_url": "https://files.pythonhosted.org/packages/06/ff/435e09492ebfd6894e1ff0d43ee56cc30aeece9c4cee1b5654f06dac5436/arrapi-1.4.13.tar.gz",
    "platform": null,
    "description": "ArrAPI\n==========================================================\n\n.. image:: https://img.shields.io/github/v/release/Kometa-Team/ArrAPI?style=plastic\n    :target: https://github.com/Kometa-Team/ArrAPI/releases\n    :alt: GitHub release (latest by date)\n\n.. image:: https://img.shields.io/travis/com/Kometa-Team/ArrAPI?style=plastic\n    :target: https://app.travis-ci.com/Kometa-Team/ArrAPI\n    :alt: Build Testing\n\n.. image:: https://img.shields.io/github/commits-since/Kometa-Team/ArrAPI/latest?style=plastic\n    :target: https://github.com/Kometa-Team/ArrAPI/commits/master\n    :alt: GitHub commits since latest release (by date) for a branch\n\n.. image:: https://img.shields.io/pypi/v/ArrAPI?style=plastic\n    :target: https://pypi.org/project/arrapi/\n    :alt: PyPI\n\n.. image:: https://img.shields.io/pypi/dm/arrapi.svg?style=plastic\n    :target: https://pypi.org/project/arrapi/\n    :alt: Downloads\n\n|\n\n.. image:: https://img.shields.io/readthedocs/arrapi?style=plastic\n    :target: https://arrapi.kometa.wiki\n    :alt: Wiki\n\n.. image:: https://img.shields.io/discord/822460010649878528?color=%2300bc8c&label=Discord&style=plastic\n    :target: https://kometa.wiki/en/latest/discord/\n    :alt: Discord\n\n.. image:: https://img.shields.io/reddit/subreddit-subscribers/Kometa?color=%2300bc8c&label=r%2FKometa&style=plastic\n    :target: https://www.reddit.com/r/Kometa/\n    :alt: Reddit\n\n.. image:: https://img.shields.io/github/sponsors/meisnate12?color=%238a2be2&style=plastic\n    :target: https://github.com/sponsors/meisnate12\n    :alt: GitHub Sponsors\n\n.. image:: https://img.shields.io/badge/-Sponsor_or_Donate-blueviolet?style=plastic\n    :target: https://github.com/sponsors/Kometa-Team\n    :alt: Sponsor or Donate\n\nOverview\n----------------------------------------------------------\nUnofficial Python bindings for the Sonarr and Radarr APIs. The goal is to make interaction with the API as easy as possible while emulating the Web Client as much as possible\n\n\nInstallation & Documentation\n----------------------------------------------------------\n\n.. code-block:: python\n\n    pip install arrapi\n\nDocumentation_ can be found at Read the Docs.\n\n.. _Documentation: https://arrapi.kometa.wiki\n\nConnecting to Sonarr\n==========================================================\n\nGetting a SonarrAPI Instance\n----------------------------------------------------------\n\nTo connect to a Sonarr application you have to use the |SonarrAPI|_ object and provide it with the ``baseurl`` and ``apikey`` parameters.\n\nThe ``apikey`` can be found by going to ``Settings > General > Security > API Key``\n\n.. code-block:: python\n\n    from arrapi import SonarrAPI\n\n    baseurl = \"http://192.168.1.12:8989\"\n    apikey = \"0010843563404748808d3fc9c562c05e\"\n\n    sonarr = SonarrAPI(baseurl, apikey)\n\nUsing the SonarrAPI Instance\n----------------------------------------------------------\n\nOnce you have a |SonarrAPI|_ instance you can use it to interact with the application.\n\nTo add, edit, or delete a singular Series you must first find the |Series|_ object.\n\nFind a Series Object\n----------------------------------------------------------\n\nThere are three ways to find a |Series|_ object.\n\nYou can get a |Series|_ object using |get_series|_ and giving it a ``Sonarr Series ID`` or ``TVDb ID``.\n\n.. code-block:: python\n\n    series = sonarr.get_series(tvdb_id=121361)\n\nYou can get a ``List`` of |Series|_ objects using |search_series|_ and giving it a search term.\n\n.. code-block:: python\n\n    search = sonarr.search_series(\"Game of Thrones\")\n\nYou can get a ``List`` of all |Series|_ objects in Sonarr using |all_series|_.\n\n.. code-block:: python\n\n    all_series = sonarr.all_series()\n\nUsing a Series Object\n----------------------------------------------------------\n\nTo add a series to Sonarr use |sonarr_add|_.\n\n.. code-block:: python\n\n    series.add(\"/shows/\", \"HD-1080p\", \"English\")\n\nTo edit a series in Sonarr use |sonarr_edit|_.\n\n.. code-block:: python\n\n    series.edit(tags=[\"hd\"])\n\nTo delete a series in Sonarr use |sonarr_delete|_.\n\n.. code-block:: python\n\n    series.delete()\n\nPerform Operations on Multiple Series\n----------------------------------------------------------\n\nTo add multiple Series to Sonarr use |add_multiple_series|_ with the Series' TVDb IDs.\n\n.. code-block:: python\n\n    series_ids = [83268, 283468, 385376]\n    added, exists, invalid = sonarr.add_multiple_series(series_ids, \"/shows/\", \"HD-1080p\", \"English\")\n\nTo edit multiple Series in Sonarr use |edit_multiple_series|_ with the Series' TVDb IDs.\n\n.. code-block:: python\n\n    series_ids = [83268, 283468, 385376]\n    edited, not_exist = sonarr.edit_multiple_series(series_ids, monitor=False)\n\nTo delete multiple Series in Sonarr use |delete_multiple_series|_ with the Series' TVDb IDs.\n\n.. code-block:: python\n\n    series_ids = [83268, 283468, 385376]\n    not_exist = sonarr.delete_multiple_series(series_ids)\n\nRespect Sonarr List Exclusions\n----------------------------------------------------------\n\nTo respect Sonarr's List Exclusions, before running |sonarr_add|_ or |add_multiple_series|_ you can use |sonarr_exclusions|_ like so.\n\n.. code-block:: python\n\n    series_ids = [83268, 283468, 385376]\n    sonarr.respect_list_exclusions_when_adding()\n    added, exists, invalid = sonarr.add_multiple_series(series_ids, \"/shows/\", \"HD-1080p\", \"English\")\n\nConnecting to Radarr\n==========================================================\n\nGetting a RadarrAPI Instance\n----------------------------------------------------------\n\nTo connect to a Radarr application you have to use the |RadarrAPI|_ object and provide it with the ``baseurl`` and ``apikey`` parameters.\n\nThe ``apikey`` can be found by going to ``Settings > General > Security > API Key``\n\n.. code-block:: python\n\n    from arrapi import RadarrAPI\n\n    baseurl = \"http://192.168.1.12:8989\"\n    apikey = \"0010843563404748808d3fc9c562c05e\"\n\n    radarr = RadarrAPI(baseurl, apikey)\n\nUsing the RadarrAPI Instance\n----------------------------------------------------------\n\nOnce you have a |RadarrAPI|_ instance you can use it to interact with the application.\n\nTo add, edit, or delete a singular Movie you must first find the |Movie|_ object.\n\nFind a Movie Object\n----------------------------------------------------------\n\nThere are three ways to find a |Movie|_ object.\n\nYou can get a |Movie|_ object using |get_movie|_ and giving it a ``Radarr Movie ID`` or ``TVDb ID``.\n\n.. code-block:: python\n\n    movie = radarr.get_movie(tmdb_id=121361)\n\nYou can get a ``List`` of |Movie|_ objects using |search_movies|_ and giving it a search term.\n\n.. code-block:: python\n\n    search = radarr.search_movies(\"The Lord of the Rings: The Return of the King\")\n\nYou can get a ``List`` of all |Movie|_ objects in Radarr using |all_movies|_.\n\n.. code-block:: python\n\n    all_movies = radarr.all_movies()\n\nUsing a Movie Object\n----------------------------------------------------------\n\nTo add a movie to Radarr use |radarr_add|_.\n\n.. code-block:: python\n\n    movie.add(\"/movies/\", \"HD-1080p\")\n\nTo edit a movie in Radarr use |radarr_edit|_.\n\n.. code-block:: python\n\n    movie.edit(tags=[\"hd\"])\n\nTo delete a movie in Radarr use |radarr_delete|_.\n\n.. code-block:: python\n\n    movie.delete()\n\nPerform Operations on Multiple Movie\n----------------------------------------------------------\n\nTo add multiple Movies to Radarr use |add_multiple_movies|_ with the Movie's TMDb IDs.\n\n.. code-block:: python\n\n    movie_ids = [11, 1891, 1892, 1893, 1894, 1895]\n    added, exists, invalid = radarr.add_multiple_movies(movie_ids, \"/movies/\", \"HD-1080p\")\n\nTo edit multiple Movies in Radarr use |edit_multiple_movies|_ with the Movie's TMDb IDs.\n\n.. code-block:: python\n\n    movie_ids = [11, 1891, 1892, 1893, 1894, 1895]\n    edited, not_exist = radarr.edit_multiple_movies(movie_ids, monitor=False)\n\nTo delete multiple Movies in Radarr use |delete_multiple_movies|_ with the Movie's TMDb IDs.\n\n.. code-block:: python\n\n    movie_ids = [11, 1891, 1892, 1893, 1894, 1895]\n    not_exist = radarr.delete_multiple_movies(movie_ids)\n\nRespect Radarr List Exclusions\n----------------------------------------------------------\n\nTo respect Radarr's List Exclusions, before running |radarr_add|_ or |add_multiple_movies|_ you can use |radarr_exclusions|_ like so.\n\n.. code-block:: python\n\n    movie_ids = [11, 1891, 1892, 1893, 1894, 1895]\n    radarr.respect_list_exclusions_when_adding()\n    added, exists, invalid = radarr.add_multiple_movies(movie_ids, \"/movies/\", \"HD-1080p\")\n\nUsage Examples\n==========================================================\n\nExample 1: List all series in Sonarr.\n\n.. code-block:: python\n\n    series = sonarr.all_series()\n    for show in series:\n        print(show.title)\n\nExample 2: Search for a movie and add it to Radarr by name.\n\n.. code-block:: python\n\n    search = radarr.search_movies(\"The Lord of the Rings: The Return of the King\")\n    if search:\n        search[0].add(\"/movies/\", \"HD-1080p\")\n\nExample 3: Make every series in Sonarr Unmonitored.\n\n.. code-block:: python\n\n    edited, not_exist = sonarr.edit_multiple_series(sonarr.all_series(), monitor=False)\n\nExample 4: Get all Quality Profiles Available.\n\n.. code-block:: python\n\n    for qp in sonarr.quality_profile():\n        print(qp.name)\n\nHyperlinks\n----------------------------------------------------------\n\n* `Radarr v3 API Docs <https://radarr.video/docs/api>`_\n* `Sonarr v3 API Docs <https://sonarr.tv/docs/api/>`_\n\n.. |SonarrAPI| replace:: ``SonarrAPI``\n.. _SonarrAPI: https://arrapi.kometa.wiki/en/latest/sonarr.html#module-arrapi.sonarr\n\n.. |Series| replace:: ``Series``\n.. _Series: https://arrapi.kometa.wiki/en/latest/objs.html#series\n\n.. |get_series| replace:: ``get_series``\n.. _get_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.get_series\n\n.. |search_series| replace:: ``search_series``\n.. _search_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.search_series\n\n.. |all_series| replace:: ``all_series``\n.. _all_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.all_series\n\n.. |sonarr_add| replace:: ``add``\n.. _sonarr_add: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Series.add\n\n.. |sonarr_edit| replace:: ``edit``\n.. _sonarr_edit: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Series.edit\n\n.. |sonarr_delete| replace:: ``delete``\n.. _sonarr_delete: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Series.delete\n\n.. |add_multiple_series| replace:: ``add_multiple_series``\n.. _add_multiple_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.add_multiple_series\n\n.. |edit_multiple_series| replace:: ``edit_multiple_series``\n.. _edit_multiple_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.edit_multiple_series\n\n.. |delete_multiple_series| replace:: ``delete_multiple_series``\n.. _delete_multiple_series: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.delete_multiple_series\n\n.. |sonarr_exclusions| replace:: ``sonarr_exclusions``\n.. _sonarr_exclusions: https://arrapi.kometa.wiki/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.respect_list_exclusions_when_adding\n\n.. |RadarrAPI| replace:: ``RadarrAPI``\n.. _RadarrAPI: https://arrapi.kometa.wiki/en/latest/radarr.html#module-arrapi.radarr\n\n.. |Movie| replace:: ``Movie``\n.. _Movie: https://arrapi.kometa.wiki/en/latest/objs.html#movie\n\n.. |get_movie| replace:: ``get_movie``\n.. _get_movie: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.get_movie\n\n.. |search_movies| replace:: ``search_movies``\n.. _search_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.search_movies\n\n.. |all_movies| replace:: ``all_movies``\n.. _all_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.all_movies\n\n.. |radarr_add| replace:: ``add``\n.. _radarr_add: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Movie.add\n\n.. |radarr_edit| replace:: ``edit``\n.. _radarr_edit: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Movie.edit\n\n.. |radarr_delete| replace:: ``delete``\n.. _radarr_delete: https://arrapi.kometa.wiki/en/latest/objs.html#arrapi.objs.Movie.delete\n\n.. |add_multiple_movies| replace:: ``add_multiple_movies``\n.. _add_multiple_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.add_multiple_movies\n\n.. |edit_multiple_movies| replace:: ``edit_multiple_movies``\n.. _edit_multiple_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.edit_multiple_movies\n\n.. |delete_multiple_movies| replace:: ``delete_multiple_movies``\n.. _delete_multiple_movies: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.delete_multiple_movies\n\n.. |radarr_exclusions| replace:: ``radarr_exclusions``\n.. _radarr_exclusions: https://arrapi.kometa.wiki/en/latest/radarr.html#arrapi.radarr.RadarrAPI.respect_list_exclusions_when_adding\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Python wrapper for Radarr and Sonarr APIs:",
    "version": "1.4.13",
    "project_urls": {
        "Documentation": "https://arrapi.kometa.wiki",
        "Funding": "https://github.com/sponsors/meisnate12",
        "Homepage": "https://github.com/Kometa-Team/ArrAPI",
        "Issues": "https://github.com/Kometa-Team/ArrAPI/issues",
        "Source": "https://github.com/Kometa-Team/ArrAPI"
    },
    "split_keywords": [
        "arrapi",
        " sonarr",
        " radarr",
        " arr",
        " wrapper",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d1cebf69a8a4ca3bd45ba53415759bce13442bc38065c798de2eda1aea4bb9e1",
                "md5": "b6f47eec1b61bef24bb7791e1be26979",
                "sha256": "d2f2a37d3334a69fa1e5405359d087822a36f0d1081b2c16878f4d0a283205d1"
            },
            "downloads": -1,
            "filename": "arrapi-1.4.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b6f47eec1b61bef24bb7791e1be26979",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 30353,
            "upload_time": "2024-04-25T06:21:52",
            "upload_time_iso_8601": "2024-04-25T06:21:52.809515Z",
            "url": "https://files.pythonhosted.org/packages/d1/ce/bf69a8a4ca3bd45ba53415759bce13442bc38065c798de2eda1aea4bb9e1/arrapi-1.4.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "06ff435e09492ebfd6894e1ff0d43ee56cc30aeece9c4cee1b5654f06dac5436",
                "md5": "81864bd8c57e8ceaaf42ed72ebce7305",
                "sha256": "d15da5722d674649067e9597318ee91e5d5363039dad4e499785c0be6fd42271"
            },
            "downloads": -1,
            "filename": "arrapi-1.4.13.tar.gz",
            "has_sig": false,
            "md5_digest": "81864bd8c57e8ceaaf42ed72ebce7305",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 27928,
            "upload_time": "2024-04-25T06:21:54",
            "upload_time_iso_8601": "2024-04-25T06:21:54.894488Z",
            "url": "https://files.pythonhosted.org/packages/06/ff/435e09492ebfd6894e1ff0d43ee56cc30aeece9c4cee1b5654f06dac5436/arrapi-1.4.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-25 06:21:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Kometa-Team",
    "github_project": "ArrAPI",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "setuptools",
            "specs": []
        }
    ],
    "lcname": "arrapi"
}
        
Elapsed time: 0.24228s