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.25.tar.gz
(45.4 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2021.12.25.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3608f28e46baec5112efc91ca56ab957d963d42aa79648e7f509d6c0a54cf647 |
|
MD5 | 5908e702a70989915f03eb81504faa26 |
|
BLAKE2b-256 | 54991e275d8d5e689bf86f6f6addb692aec239c0709c10c2221a6470a92cc1b9 |
Close
Hashes for qbittorrent_api-2021.12.25-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5d39c29eac14ef13444202c08b0ecf30db16f9e889089354f0b98e09671fee3 |
|
MD5 | ca89b4946b899132052ebb7767d75630 |
|
BLAKE2b-256 | 3ccea6fbb96247b032e080d930c1c73bbabd1aebbbd234f0173b78f3db3b495c |