Skip to main content

Python client implementation for qBittorrent Web API v2 first available in qBittorrent v4.1.

Project description

qBittorrent Web API v2 Client
========
Python client implementation for qBittorrent Web API v2 first available in qBittorrent v4.1.

API Documentation: https://github.com/qbittorrent/qBittorrent/wiki/Web-API-Documentation

Change Log
--------
* Version 0.1.1
* Complete implementation of each endpoint for qBittorrent Web API v2

TO DO
--------
* Create automated test scripts
* Create interaction layer to allow for more fluid access to endpoints. That way, developers don't have to hit individual endpoints and can instead transparently interact with qBittorrent.

Installation
------------

*qbittorrent* is available on the Python Package Index(PyPI).

https://pypi.org/project/qbittorrent-api/

You can install *qbittorrentapi* using one of the following techniques:

- Use pip: :code:`pip install qbittorrent-api`
- Download the .zip or .tar.gz file from PyPI and install
- Download the source from Github and install

https://github.com/rmartin16/qbittorrent-api

Be sure to also install requests and attrdict.

Ensure that the WebUI is enabled in qBittorrent: Tools -> Preferences -> Web UI

Getting Started
--------

:code:`>>> import qbittorrentapi`

:code:`>>> client = qbittorrentapi.Client(host='http://localhost:8080', username='admin', password='adminadmin')`

:code:`>>> print("qBittorrent Version: %s" % client.app_version())`

:code:`>>> help(qbittorrentapi.Client)`


Project details


Release history Release notifications | RSS feed

This version

0.1.2

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-0.1.2.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qbittorrent_api-0.1.2-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

Details for the file qbittorrent-api-0.1.2.tar.gz.

File metadata

  • Download URL: qbittorrent-api-0.1.2.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for qbittorrent-api-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5c3126caa0ce15cddaa5e4e03bf2f1abaa9afc7094304bf9b207e38d922312fe
MD5 cefc1db423e2d3611f9b78e712b8ffed
BLAKE2b-256 6eaa299f5b0d364aecb798c16afdb76e258d8d102d5f1a7e37a63ab7b4e23ca8

See more details on using hashes here.

File details

Details for the file qbittorrent_api-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: qbittorrent_api-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 26.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for qbittorrent_api-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7b6a8f09336de61f3e96f9638e1838c24b0113789f80c559f42e3b4c5b58c7f9
MD5 e80e96844dce3209fe87325b54d0fe1a
BLAKE2b-256 1a144e9f8328854833b0313baa0de6426a0f8aad5077c753df343e1ae1e97546

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page