Add support for torrentcreator endpoints

rmartin16 · Feb 28, 2024 · e306bc1 · e306bc1
1 parent b5ec680
commit e306bc1
Show file tree

Hide file tree

Showing 12 changed files with 552 additions and 33 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -186,12 +186,12 @@ jobs:
           name: html-coverage-report
           path: ./htmlcov
 
-      #- name: Upload Coverage to Codecov
-      #  if: contains(fromJson('["push", "pull_request"]'), github.event_name)
-      #  uses: codecov/codecov-action@v4.0.0
-      #  with:
-      #    fail_ci_if_error: true
-      #    token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Upload Coverage to Codecov
+        if: contains(fromJson('["push", "pull_request"]'), github.event_name)
+        uses: codecov/codecov-action@v4.0.0
+        with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
 
   install-dev:
     #######

diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 <div align="center">
 
 qBittorrent Web API Client
-================================
+==========================
 
 Python client implementation for qBittorrent Web API
 
-[![GitHub Workflow Status (branch)](https://img.shields.io/github/checks-status/rmartin16/qbittorrent-api/main?style=flat-square)](https://github.com/rmartin16/qbittorrent-api/actions?query=branch%3Amain) [![Codecov branch](https://img.shields.io/codecov/c/gh/rmartin16/qbittorrent-api/main?style=flat-square)](https://app.codecov.io/gh/rmartin16/qbittorrent-api) [![Coverity Scan](https://img.shields.io/coverity/scan/21227?style=flat-square)](https://scan.coverity.com/projects/rmartin16-qbittorrent-api) [![Codacy grade](https://img.shields.io/codacy/grade/ef2975376e834af1910632cb76d05832?style=flat-square)](https://app.codacy.com/gh/rmartin16/qbittorrent-api/dashboard) [![PyPI](https://img.shields.io/pypi/v/qbittorrent-api?style=flat-square)](https://pypi.org/project/qbittorrent-api/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qbittorrent-api?style=flat-square)](https://pypi.org/project/qbittorrent-api/)
+[![GitHub Workflow Status (branch)](https://img.shields.io/github/checks-status/rmartin16/qbittorrent-api/main?style=flat-square)](https://github.com/rmartin16/qbittorrent-api/actions?query=branch%3Amain) [![Codecov branch](https://img.shields.io/codecov/c/gh/rmartin16/qbittorrent-api/main?style=flat-square)](https://app.codecov.io/gh/rmartin16/qbittorrent-api) [![PyPI](https://img.shields.io/pypi/v/qbittorrent-api?style=flat-square)](https://pypi.org/project/qbittorrent-api/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qbittorrent-api?style=flat-square)](https://pypi.org/project/qbittorrent-api/)
 
 </div>
 

diff --git a/docs/source/apidoc/torrentcreator.rst b/docs/source/apidoc/torrentcreator.rst
@@ -0,0 +1,34 @@
+Torrent Creator
+================================
+
+.. autoclass:: qbittorrentapi.torrentcreator.TorrentCreatorAPIMixIn
+    :members:
+    :undoc-members:
+    :exclude-members: torrentcreator, torrentcreator_addTask, torrentcreator_torrentFile, torrentcreator_deleteTask
+    :show-inheritance:
+
+.. autoclass:: qbittorrentapi.torrentcreator.TorrentCreator
+    :members:
+    :undoc-members:
+    :exclude-members: addTask, torrentFile, deleteTask
+
+.. autoclass:: qbittorrentapi.torrentcreator.TorrentCreatorTaskDictionary
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :exclude-members: torrentFile, deleteTask
+
+.. autoclass:: qbittorrentapi.torrentcreator.TorrentCreatorTaskStatus
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: qbittorrentapi.torrentcreator.TaskStatus
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: qbittorrentapi.torrentcreator.TorrentCreatorTaskStatusList
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst
@@ -5,10 +5,6 @@ Introduction
    :target: https://github.com/rmartin16/qbittorrent-api/actions?query=branch%3Amain
 .. |codecov| image:: https://img.shields.io/codecov/c/gh/rmartin16/qbittorrent-api/main?style=flat-square
    :target: https://app.codecov.io/gh/rmartin16/qbittorrent-api
-.. |coverity| image:: https://img.shields.io/coverity/scan/21227?style=flat-square
-   :target: https://scan.coverity.com/projects/rmartin16-qbittorrent-api
-.. |codacy| image:: https://img.shields.io/codacy/grade/ef2975376e834af1910632cb76d05832?style=flat-square
-   :target: https://app.codacy.com/gh/rmartin16/qbittorrent-api/dashboard
 
 .. |pypi| image:: https://img.shields.io/pypi/v/qbittorrent-api?style=flat-square
    :target: https://pypi.org/project/qbittorrent-api/
@@ -17,7 +13,7 @@ Introduction
 .. |pypi downloads| image:: https://img.shields.io/pypi/dw/qbittorrent-api?color=blue&style=flat-square
    :target: https://pypi.org/project/qbittorrent-api/
 
-|github ci| |codecov| |coverity| |codacy|
+|github ci| |codecov|
 
 |pypi| |pypi versions| |pypi downloads|
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -46,6 +46,7 @@ dev = [
     "pre-commit ==3.6.0 ; python_version >= '3.9'",
     "pytest ==8.0.0",
     "sphinx ==7.2.6; python_version >= '3.9'",
+    "sphinx-autobuild ==2024.2.4 ; python_version >= '3.9'",
     "sphinx-copybutton ==0.5.2",
     "sphinxcontrib-spelling ==8.0.0",
     "sphinx-autodoc-typehints ==1.25.3",

diff --git a/src/qbittorrentapi/__init__.py b/src/qbittorrentapi/__init__.py
@@ -62,6 +62,14 @@
     SyncMainDataDictionary,
     SyncTorrentPeersDictionary,
 )
+from qbittorrentapi.torrentcreator import (
+    TaskStatus,
+    TorrentCreator,
+    TorrentCreatorAPIMixIn,
+    TorrentCreatorTaskDictionary,
+    TorrentCreatorTaskStatus,
+    TorrentCreatorTaskStatusList,
+)
 from qbittorrentapi.torrents import (
     Tag,
     TagList,
@@ -137,6 +145,12 @@
     "SyncTorrentPeersDictionary",
     "Tag",
     "TagList",
+    "TaskStatus",
+    "TorrentCreator",
+    "TorrentCreatorAPIMixIn",
+    "TorrentCreatorTaskDictionary",
+    "TorrentCreatorTaskStatus",
+    "TorrentCreatorTaskStatusList",
     "TorrentCategoriesDictionary",
     "TorrentDictionary",
     "TorrentFile",

diff --git a/src/qbittorrentapi/client.py b/src/qbittorrentapi/client.py
@@ -6,6 +6,7 @@
 from qbittorrentapi.rss import RSSAPIMixIn
 from qbittorrentapi.search import SearchAPIMixIn
 from qbittorrentapi.sync import SyncAPIMixIn
+from qbittorrentapi.torrentcreator import TorrentCreatorAPIMixIn
 from qbittorrentapi.torrents import TorrentsAPIMixIn
 from qbittorrentapi.transfer import TransferAPIMixIn
 
@@ -49,6 +50,7 @@ class Client(
     SyncAPIMixIn,
     TransferAPIMixIn,
     TorrentsAPIMixIn,
+    TorrentCreatorAPIMixIn,
     RSSAPIMixIn,
     SearchAPIMixIn,
 ):

diff --git a/src/qbittorrentapi/definitions.py b/src/qbittorrentapi/definitions.py
@@ -58,6 +58,7 @@ class APINames(str, Enum):
     Sync = "sync"
     Transfer = "transfer"
     Torrents = "torrents"
+    TorrentCreator = "torrentcreator"
     RSS = "rss"
     Search = "search"
     EMPTY = ""

diff --git a/src/qbittorrentapi/request.py b/src/qbittorrentapi/request.py
@@ -48,6 +48,7 @@
     from qbittorrentapi.rss import RSS
     from qbittorrentapi.search import Search
     from qbittorrentapi.sync import Sync
+    from qbittorrentapi.torrentcreator import TorrentCreator
     from qbittorrentapi.torrents import TorrentCategories, Torrents, TorrentTags
     from qbittorrentapi.transfer import Transfer
 
@@ -280,6 +281,7 @@ def __init__(
         self._torrents: Torrents | None = None
         self._torrent_categories: TorrentCategories | None = None
         self._torrent_tags: TorrentTags | None = None
+        self._torrentcreator: TorrentCreator | None = None
         self._transfer: Transfer | None = None
 
         # turn off console-printed warnings about SSL certificate issues.
@@ -313,6 +315,7 @@ def _initialize_context(self) -> None:
         self._torrents = None
         self._torrent_categories = None
         self._torrent_tags = None
+        self._torrentcreator = None
         self._log = None
         self._sync = None
         self._rss = None