doc update

Kometa-Team · Nov 11, 2021 · a943a6f · a943a6f
1 parent e678d87
commit a943a6f
Show file tree

Hide file tree

Showing 2 changed files with 127 additions and 69 deletions.
diff --git a/README.rst b/README.rst
@@ -1,6 +1,10 @@
 ArrAPI
 ==========================================================
 
+.. image:: https://img.shields.io/travis/com/meisnate12/ArrAPI?style=plastic
+    :target: https://app.travis-ci.com/meisnate12/ArrAPI
+    :alt: Build Testing
+
 .. image:: https://img.shields.io/readthedocs/arrapi?style=plastic
     :target: https://arrapi.readthedocs.io/en/latest/?badge=latest
     :alt: Read the Docs
@@ -60,47 +64,32 @@ The ``apikey`` can be found by going to ``Settings > General > Security > API Ke
 
     sonarr = SonarrAPI(baseurl, apikey)
 
-.. |SonarrAPI| replace:: ``SonarrAPI``
-.. _SonarrAPI: https://arrapi.readthedocs.io/en/latest/sonarr.html#module-arrapi.sonarr
-
 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.
 
-.. |Series| replace:: ``Series``
-.. _Series: https://arrapi.readthedocs.io/en/latest/objs.html#series
-
 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``.
 
-.. |get_series| replace:: ``get_series``
-.. _get_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.get_series
-
 .. 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.
 
-.. |search_series| replace:: ``search_series``
-.. _search_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.search_series
-
 .. code-block:: python
 
     search = sonarr.search_series("Game of Thrones")
 
 You can get a ``List`` of all |Series|_ objects in Sonarr using |all_series|_.
 
-.. |all_series| replace:: ``all_series``
-.. _all_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.all_series
-
 .. code-block:: python
 
     all_series = sonarr.all_series()
@@ -110,27 +99,18 @@ Using a Series Object
 
 To add a series to Sonarr use |sonarr_add|_.
 
-.. |sonarr_add| replace:: ``add``
-.. _sonarr_add: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Series.add
-
 .. code-block:: python
 
     series.add("/shows/", "HD-1080p", "English")
 
 To edit a series in Sonarr use |sonarr_edit|_.
 
-.. |sonarr_edit| replace:: ``edit``
-.. _sonarr_edit: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Series.edit
-
 .. code-block:: python
 
     series.edit(tags=["hd"])
 
 To delete a series in Sonarr use |sonarr_delete|_.
 
-.. |sonarr_delete| replace:: ``delete``
-.. _sonarr_delete: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Series.delete
-
 .. code-block:: python
 
     series.delete()
@@ -140,34 +120,36 @@ Perform Operations on Multiple Series
 
 To add multiple Series to Sonarr use |add_multiple_series|_ with the Series' TVDb IDs.
 
-.. |add_multiple_series| replace:: ``add_multiple_series``
-.. _add_multiple_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.add_multiple_series
-
 .. 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.
 
-.. |edit_multiple_series| replace:: ``edit_multiple_series``
-.. _edit_multiple_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.edit_multiple_series
-
 .. 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.
 
-.. |delete_multiple_series| replace:: ``delete_multiple_series``
-.. _delete_multiple_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.delete_multiple_series
-
 .. 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
 ==========================================================
 
@@ -187,47 +169,32 @@ The ``apikey`` can be found by going to ``Settings > General > Security > API Ke
 
     radarr = RadarrAPI(baseurl, apikey)
 
-.. |RadarrAPI| replace:: ``RadarrAPI``
-.. _RadarrAPI: https://arrapi.readthedocs.io/en/latest/radarr.html#module-arrapi.radarr
-
 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.
 
-.. |Movie| replace:: ``Movie``
-.. _Movie: https://arrapi.readthedocs.io/en/latest/objs.html#movie
-
 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``.
 
-.. |get_movie| replace:: ``get_movie``
-.. _get_movie: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.get_movie
-
 .. 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.
 
-.. |search_movies| replace:: ``search_movies``
-.. _search_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.search_movies
-
 .. code-block:: python
 
-    search = radarr.search_movies("Game of Thrones")
+    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|_.
 
-.. |all_movies| replace:: ``all_movies``
-.. _all_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.all_movies
-
 .. code-block:: python
 
     all_movies = radarr.all_movies()
@@ -237,27 +204,18 @@ Using a Movie Object
 
 To add a movie to Radarr use |radarr_add|_.
 
-.. |radarr_add| replace:: ``add``
-.. _radarr_add: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Movie.add
-
 .. code-block:: python
 
     movie.add("/movies/", "HD-1080p")
 
 To edit a movie in Radarr use |radarr_edit|_.
 
-.. |radarr_edit| replace:: ``edit``
-.. _radarr_edit: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Movie.edit
-
 .. code-block:: python
 
     movie.edit(tags=["hd"])
 
 To delete a movie in Radarr use |radarr_delete|_.
 
-.. |radarr_delete| replace:: ``delete``
-.. _radarr_delete: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Movie.delete
-
 .. code-block:: python
 
     movie.delete()
@@ -267,34 +225,36 @@ Perform Operations on Multiple Movie
 
 To add multiple Movies to Radarr use |add_multiple_movies|_ with the Movie's TMDb IDs.
 
-.. |add_multiple_movies| replace:: ``add_multiple_movies``
-.. _add_multiple_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.add_multiple_movies
-
 .. 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.
 
-.. |edit_multiple_movies| replace:: ``edit_multiple_movies``
-.. _edit_multiple_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.edit_multiple_movies
-
 .. 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.
 
-.. |delete_multiple_movies| replace:: ``delete_multiple_movies``
-.. _delete_multiple_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.delete_multiple_movies
-
 .. 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
 ==========================================================
 
@@ -333,3 +293,75 @@ Hyperlinks
 * `Radarr v3 API Docs <https://radarr.video/docs/api>`_
 * `Sonarr API Docs <https://github.com/Sonarr/Sonarr/wiki/API>`_
 * Theres no Docs for Sonarr v3 Yet.
+
+.. |SonarrAPI| replace:: ``SonarrAPI``
+.. _SonarrAPI: https://arrapi.readthedocs.io/en/latest/sonarr.html#module-arrapi.sonarr
+
+.. |Series| replace:: ``Series``
+.. _Series: https://arrapi.readthedocs.io/en/latest/objs.html#series
+
+.. |get_series| replace:: ``get_series``
+.. _get_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.get_series
+
+.. |search_series| replace:: ``search_series``
+.. _search_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.search_series
+
+.. |all_series| replace:: ``all_series``
+.. _all_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.all_series
+
+.. |sonarr_add| replace:: ``add``
+.. _sonarr_add: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Series.add
+
+.. |sonarr_edit| replace:: ``edit``
+.. _sonarr_edit: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Series.edit
+
+.. |sonarr_delete| replace:: ``delete``
+.. _sonarr_delete: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Series.delete
+
+.. |add_multiple_series| replace:: ``add_multiple_series``
+.. _add_multiple_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.add_multiple_series
+
+.. |edit_multiple_series| replace:: ``edit_multiple_series``
+.. _edit_multiple_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.edit_multiple_series
+
+.. |delete_multiple_series| replace:: ``delete_multiple_series``
+.. _delete_multiple_series: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.delete_multiple_series
+
+.. |sonarr_exclusions| replace:: ``sonarr_exclusions``
+.. _sonarr_exclusions: https://arrapi.readthedocs.io/en/latest/sonarr.html#arrapi.sonarr.SonarrAPI.respect_list_exclusions_when_adding
+
+.. |RadarrAPI| replace:: ``RadarrAPI``
+.. _RadarrAPI: https://arrapi.readthedocs.io/en/latest/radarr.html#module-arrapi.radarr
+
+.. |Movie| replace:: ``Movie``
+.. _Movie: https://arrapi.readthedocs.io/en/latest/objs.html#movie
+
+.. |get_movie| replace:: ``get_movie``
+.. _get_movie: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.get_movie
+
+.. |search_movies| replace:: ``search_movies``
+.. _search_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.search_movies
+
+.. |all_movies| replace:: ``all_movies``
+.. _all_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.all_movies
+
+.. |radarr_add| replace:: ``add``
+.. _radarr_add: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Movie.add
+
+.. |radarr_edit| replace:: ``edit``
+.. _radarr_edit: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Movie.edit
+
+.. |radarr_delete| replace:: ``delete``
+.. _radarr_delete: https://arrapi.readthedocs.io/en/latest/objs.html#arrapi.objs.Movie.delete
+
+.. |add_multiple_movies| replace:: ``add_multiple_movies``
+.. _add_multiple_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.add_multiple_movies
+
+.. |edit_multiple_movies| replace:: ``edit_multiple_movies``
+.. _edit_multiple_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.edit_multiple_movies
+
+.. |delete_multiple_movies| replace:: ``delete_multiple_movies``
+.. _delete_multiple_movies: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.delete_multiple_movies
+
+.. |radarr_exclusions| replace:: ``radarr_exclusions``
+.. _radarr_exclusions: https://arrapi.readthedocs.io/en/latest/radarr.html#arrapi.radarr.RadarrAPI.respect_list_exclusions_when_adding
diff --git a/docs/intro.rst b/docs/intro.rst
@@ -2,7 +2,7 @@
 Welcome to ArrAPI's documentation!
 ==========================================================
 
-.. image:: https://app.travis-ci.com/meisnate12/ArrAPI.svg?branch=master&style=plastic
+.. image:: https://img.shields.io/travis/com/meisnate12/ArrAPI?style=plastic
     :target: https://app.travis-ci.com/meisnate12/ArrAPI
     :alt: Build Testing
 
@@ -18,6 +18,10 @@ Welcome to ArrAPI's documentation!
     :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/github/commits-since/meisnate12/ArrAPI/latest?style=plastic
     :target: https://github.com/meisnate12/ArrAPI/commits/master
     :alt: GitHub commits since latest release (by date) for a branch
@@ -138,6 +142,17 @@ To delete multiple Series in Sonarr use :meth:`~arrapi.apis.sonarr.SonarrAPI.del
     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 :meth:`~arrapi.objs.reload.Series.add` or :meth:`~arrapi.apis.sonarr.SonarrAPI.add_multiple_series` you can use :meth:`~arrapi.apis.sonarr.SonarrAPI.respect_list_exclusions_when_adding` 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
 ==========================================================
 
@@ -179,7 +194,7 @@ You can get a ``List`` of :class:`~arrapi.objs.reload.Movie` objects using :meth
 
 .. code-block:: python
 
-    search = radarr.search_movies("Game of Thrones")
+    search = radarr.search_movies("The Lord of the Rings: The Return of the King")
 
 You can get a ``List`` of all :class:`~arrapi.objs.reload.Movie` objects in Radarr using :meth:`~arrapi.apis.radarr.RadarrAPI.all_movies`.
 
@@ -232,6 +247,17 @@ To delete multiple Movies in Radarr use :meth:`~arrapi.apis.radarr.RadarrAPI.del
     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 :meth:`~arrapi.objs.reload.Series.add` or :meth:`~arrapi.apis.sonarr.SonarrAPI.add_multiple_series` you can use :meth:`~arrapi.apis.sonarr.SonarrAPI.respect_list_exclusions_when_adding` 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
 ==========================================================