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.9 (Web API v2.8.2) released on Oct 31, 2021. 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-2021.12.26.tar.gz
(45.3 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2021.12.26.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45fd1e907d87837356917d46d3bc1a1694cc8afc9c6bd8374b878a04a18f3969 |
|
MD5 | 638af2c691032a70aef905d679ccce97 |
|
BLAKE2b-256 | c85f4a34b092fd230c6868b7888ce8d00dd0863e0d08c75e8b7913f1de5b52e2 |
Close
Hashes for qbittorrent_api-2021.12.26-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c728c41202ae58047996697a4fc8ab2233f52f3a5c8983143d8ea42992cb1508 |
|
MD5 | ce1f7fc585b15abef69a3c6585938775 |
|
BLAKE2b-256 | 9706ca4240a6643b27c0e4234ff75e59879ba34fde522b936cafa905d191c2f7 |