Python client for qBittorrent v4.1+ Web API.
Project description
qBittorrent Web API Client
Python client implementation for qBittorrent Web API.
Currently supports qBittorrent v4.4.3.1 (Web API v2.8.5) released on May 24, 2022.
User Guide and API Reference available on Read the Docs.
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.8.35.tar.gz
(69.1 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2022.8.35.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59ed8470ba81ddea2bcdf9d989a46d653db6589b48026108002f11da4712597c |
|
MD5 | aeb6ee047df922bc81c563347083b2b3 |
|
BLAKE2b-256 | 3ca35f2b84c155ba44cf1bd90745be6ad432ec9e7829babff8099c17d4ce608e |
Close
Hashes for qbittorrent_api-2022.8.35-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae41e6fb36e1bb90f0bc9d7a941397adc518fe986fc744252f0f693160086249 |
|
MD5 | 77d8300d320b4541c1c64a1d41cf3c1d |
|
BLAKE2b-256 | 3287862a2a562b3f9f44a58b2783681f88bf74af5215569604b3a956162b6ffb |