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.4.1 (Web API v2.8.5) released on Feb 15, 2022.
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 strictly necessary;
# however, you may 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-2022.2.28.tar.gz
(46.5 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2022.2.28.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f5eea51b81574156f6fdb1d33eb9329ee5798f700b8d5e717956451e7fc15bb |
|
MD5 | 6d19bbc2bf6f3c1a750fa356505a00b0 |
|
BLAKE2b-256 | 995ce25ff4d88ab594bfb75cfd5411705685529410a81ca5a9f0f90e4a98ca29 |
Close
Hashes for qbittorrent_api-2022.2.28-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 797362534f33b7fe23111a610c09f1b0b5cc90d0cab18025ddbacf8838bcc61a |
|
MD5 | 9f05b107ab3b3af23c9492fa90a51a8c |
|
BLAKE2b-256 | d7dc9367ae10b224d262c9b10c47460f4b36aaf3741b8325331bc3b2521a4493 |