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.3.18.tar.gz
(43.5 kB
view hashes)
Built Distribution
Close
Hashes for qbittorrent-api-2021.3.18.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc63aa8bac67921877e391ddcde44b226303e6a3f678644dbb4523d7c5be5add |
|
MD5 | d86411d70c5005c7c932454341e40e00 |
|
BLAKE2b-256 | 901222588b2f5434b698ddaeb943fbf3a80749d037d00c1256638a30ea5bb188 |
Close
Hashes for qbittorrent_api-2021.3.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2d5f4e590c7d230e655956cbbd87db3cea9f9d9fae059259045036aa11924b5 |
|
MD5 | af2f184c78349558c9b2c42acd1d315c |
|
BLAKE2b-256 | a2e0854ff34766e78bce61c2539bc89d54984f38efa6aa4672869378dfb3081d |