Python client for qBittorrent v4.1+ Web API
Project description
qBittorrent Web API Client
Python client implementation for qBittorrent Web API. Supports qBittorrent v4.1.0+ (i.e. Web API v2.0+).
Currently supports up to qBittorrent v4.3.1 (Web API v2.6.1) released on November 25, 2020.
Find the full documentation for this client on RTD.
Features
- The entire qBittorrent Web API is implemented.
- qBittorrent version checking for an endpoint's existence/features is automatically handled.
- All Python versions are supported.
- If the authentication cookie expires, a new one is automatically requested in line with any API call.
Installation
Install via pip from PyPI
pip install qbittorrent-api
Getting Started
import qbittorrentapi
# instantiate a Client using the appropriate WebUI configuration
qbt_client = qbittorrentapi.Client(host='localhost', port=8080, username='admin', password='adminadmin')
# the Client will automatically acquire/maintain a logged in state in line with any request.
# therefore, this is not necessary; however, you many want to test the provided login credentials.
try:
qbt_client.auth_log_in()
except qbittorrentapi.LoginFailed as e:
print(e)
# display qBittorrent info
print(f'qBittorrent: {qbt_client.app.version}')
print(f'qBittorrent Web API: {qbt_client.app.web_api_version}')
for k,v in qbt_client.app.build_info.items(): print(f'{k}: {v}')
# retrieve and show all torrents
for torrent in qbt_client.torrents_info():
print(f'{torrent.hash[-6:]}: {torrent.name} ({torrent.state})')
# pause all torrents
qbt_client.torrents.pause.all()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
qbittorrent-api-2020.11.13.tar.gz
(45.0 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2020.11.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4466c1f59cd71849faa569f89a37a87a1a2193b21babdf82104e73c4ce70a954 |
|
MD5 | 842ee4fa4ba948f982a3ed66a5ecf5b8 |
|
BLAKE2b-256 | 8418bee5587828b783f1c4b2e547083d74e4c7d89957598f3fcb22a10d59cb35 |
Close
Hashes for qbittorrent_api-2020.11.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df6c29481b007e44b1154715d5aa36be4135a50def43ba3531cd42ea54f5686c |
|
MD5 | 5b029d650174d7ec3b353cbcea53b709 |
|
BLAKE2b-256 | 5d294c03ebe0f847d5748990a7d3ea4de6af6a8234f3513a9da878b276bce2f7 |