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.4.3 (Web API v2.8.5) released on May 22, 2022.
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-2022.5.31.tar.gz
(46.7 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2022.5.31.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b677640908f40aba7b78ca75f60675dac7eda3d8aa0a1bb60bd2a546e38bd437 |
|
MD5 | b08098439358d45838c12e50ccbcedee |
|
BLAKE2b-256 | 3d62c13a09c8b7bcd7aeb7cfc1d035a253438bdf954799db8c43b5baefab77e7 |
Close
Hashes for qbittorrent_api-2022.5.31-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63b98d2ffd5a46e7fa2c4f4931901092873584b7b5216be6eedc03eb953afc6f |
|
MD5 | e20acfefacf1bbb1e3ae936045e292a2 |
|
BLAKE2b-256 | d1e6ded0782ec68729cfa3bb6c6081d37094f0918d41130b9682cf10fd49cc9e |