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.3 (Web API v2.7) released on January 18, 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 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-2021.1.16.tar.gz
(47.3 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2021.1.16.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 443cc5d2c582c00b0a0f356fc9c8d4a9110667bcf1fba38a9b3a9624ee9a9177 |
|
MD5 | 8ced2a8a1f1d6ee0c24797be446f9cbe |
|
BLAKE2b-256 | 041e8b0eace6f695c4d4ba10b645fb289c3b95ae25fb7979149aeb4e59ec68ec |
Close
Hashes for qbittorrent_api-2021.1.16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28e692019740cc52c3f02a6200b144af9c457aea64f3eb6bc4ff86baf5e04b10 |
|
MD5 | 6144210807a3285e3b8555696e8347c4 |
|
BLAKE2b-256 | d9366a5099d536b632d538b5774e24f4addd826fcfa05a80e02de78241066f9e |