Python client for qBittorrent v4.1+ Web API.
Project description
Currently supports qBittorrent v4.4.5 (Web API v2.8.5) released on Aug 29, 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.38.tar.gz
(69.9 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2022.8.38.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 179e349259d60cd0ae301049f6a020e28ea1d809d88a945a4369ff701eff0406 |
|
MD5 | 7668314bc1d3031a7682d0e3cd4d7a8e |
|
BLAKE2b-256 | c0de7f95f27607bf3c5e8a13a02de395536c019e6d41514c9a982d042213178a |
Close
Hashes for qbittorrent_api-2022.8.38-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43ef0227e41d644f9db88d40ea590eda35f89545b84cf6977ac1d2b9c748ff96 |
|
MD5 | 0378a2c0cd57c42338c3cdb78b9105c0 |
|
BLAKE2b-256 | 2bd19206c8edf33ec1cb02077c69decea87851347350615e0b38cbf5b2451ec1 |