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.2 (Web API v2.7) released on December 27, 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.12.15.tar.gz
(46.9 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2020.12.15.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc1510d23222fe9c6e9d2c7108024fa268f916341fc414a474d12e34eae6e231 |
|
MD5 | 6bcb085931dc36953f23aa5f83fa268c |
|
BLAKE2b-256 | c10bfd51860779bee219322538b981b36a6aa8a7fd476e382ee03f5bde736c4c |
Close
Hashes for qbittorrent_api-2020.12.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb3b7e13f6637401ab4e045c09320f4681432ed51a222c6093496df97215b24c |
|
MD5 | d4eeca4b839b140ea79a53d2c9660c53 |
|
BLAKE2b-256 | a2f617fe884759c042000e01a78bf306960b08b81df8d12c5896d33e9f6fcf0b |