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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

Supported by

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