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.24.tar.gz
(44.9 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2021.12.24.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 115c6ada8cd67695109f128ca17727b8abd8f2b86834224468bf8e447787adae |
|
MD5 | 0583748d2b4807d8a12200bd0c467f89 |
|
BLAKE2b-256 | acf8b242162fe27f1239460255972eb46ec84b01827d7bfd76e6fc967df31438 |
Close
Hashes for qbittorrent_api-2021.12.24-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48d62c860bed1927ab5443eddb0b1d75a8f5d5b4dc5828acb2d9715dd6ae10e9 |
|
MD5 | 05b2c97fc00f69a9a8b2151b368bb0b8 |
|
BLAKE2b-256 | f5716a54c323c9a1a7e5fd11a0d865a68f71d9e7d78ea92485d4a8e728ab5336 |