qbittorrent-api

Version 2021.4.20

• Add support for ratio limit and seeding time limit when adding torrents in qBittorrent 4.3.4.1.
• Since the qBittorrent Web API is experiencing breaking changes to API signatures, this client will now attempt to manage upgrading and downgrading API signatures automatically.

Version 2021.4.19

• Update license in setup to match GPL -> MIT license change on github

Version 2021.3.18

• Replace TorrentStates.FORCE_DOWNLOAD='forceDL' with TorrentStates.FORCED_DOWNLOAD='forcedDL'

Version 2021.2.17

• Persist a Requests Session between API calls
• Organization and maintenance updates

Version 2021.1.16

• Support qBittorrent v4.3.3 and Web API v2.7 (...again)
• New torrents/renameFile and torrents/renameFolder endpoints
• Retrieve app api version when needed instead of caching
• Stop verifying and removing individual parameters when they aren't supported

Version 2020.12.15

• Support qBittorrent v4.3.2 and Web API v2.7
• torrents/add supports adding torrents with tags via "tags" parameter
• app/preferences supports toggling internationalized domain name (IDN) support via "idn_support_enabled"
• BREAKING CHANGE: for torrents/add, "is_root_folder" (or "root_folder") is superseded by "content_layout"
• For torrents/delete, "delete_files" now defaults to False instead of required being explicitly passed

Version 2020.12.14

• Add support for non-standard API endpoint paths (Fixes #37)
• Allows users to leverage this client when qBittorrent is configured behind a reverse proxy.
  • For instance, if the Web API is being exposed at "http://localhost/qbt/", then users can instantiate via Client(host='localhost/qbt') and all API endpoint paths will be prefixed with "/qbt".
• Additionally, the scheme (i.e. http or https) from the user will now be respected as the first choice for which scheme is used to communicate with qBittorrent.
  • However, users still don't need to even specify a scheme; it'll be automatically determined on the first connection to qBittorrent.
• Neither of these should be breaking changes, but if you're instantiating with an incorrect scheme or an irrelevant path, you may need to prevent doing that now.

Version 2020.11.13

• Bump for Web API v2.6.1 release
• Path of torrent content now available via content_path from torrents/info

Version 2020.11.12

• Fix support for raw bytes for torrent_files in torrents_add() for Python 3. Fixes #34.

Version 2020.10.11

• Support qBittorrent v4.3.0.1 and Web API v2.6
• Due to qBittorrent changes, /search/categories no longer returns anything and /rss/renameRule works again

Version 2020.10.10

• Advertise support for Python 3.9

Version 2020.9.9

• Only require enum34 for Python 2

Version 2020.8.8

• Support adding torrents from raw torrent files as bytes or file handles. Fixes #23.
• Introduce TorrentStates enum for qBittorrent list of torrent states.

Version 2020.7.7

• Update tests and misc small fixes.

Version 2020.7.6

• Re-release of v2020.7.5.

Version 2020.7.5

• Add RTD documentation.

Version 2020.6.4

• Bug fix release. Reorganized code and classes to be more logical.
• Started returning None from many methods that were returning Requests Responses.
• Content-Length header is now explicitly sent as "0" for any POSTs without a body.
• Endpoint input parameters "hash" and "hashes" are renamed to "torrent_hash" and "torrent_hashes". "hash" and "hashes" remain supported.
• search_uninstall_plugin now works. search_enable_plugin now supports multiple plugins.
• Torrent.download_limit now only return the value instead of a dictionary. Torrent.upload_limit now works.
• Drop advertising Python 2.6 and 3.4 support; add PyPy3 support.
• Implement test suite and CI that can test all supported qBittorrent versions on all pythons.

Version 2020.5.3

• Include currently supported qBittorrent version in README. Push new README to PyPI.

Version 2020.4.2

• Add support for rss/markAsRead and rss/matchingArticles. Added in v2.5.1. Fixes #10

Version 2020.4.1

• Add stalled(), stalled_uploading(), and stalled_downloading() to torrents.info interaction. Added in Web API v2.4.1.
• Implement torrent file renaming. Added in Web API v2.4.0. Fixes #3.
• Since versioning was botched last release, implement calendar versioning.
• List of files returned from torrents_files() now contains file ID in 'id'.