Metadata-Version: 2.1
Name: qbittorrent-api
Version: 0.1.2
Summary: Python client implementation for qBittorrent Web API v2 first available in qBittorrent v4.1.
Home-page: https://github.com/rmartin16/qbittorrent-api
Author: Russell Martin
Author-email: rmartin16@gmail.com
License: GPL-3
Keywords: qbittorrent api
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 2
Classifier: Operating System :: OS Independent
Requires-Dist: attrdict
Requires-Dist: requests

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


