Need help with python-qBittorrent?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

v1k45
168 Stars 29 Forks MIT License 69 Commits 15 Opened issues

Description

Python wrapper for qBittorrent Web API (for versions above v3.1.x)

Services available

!
?

Need anything else?

Contributors list

# 202,121
Shell
CSS
HTML
qbittor...
50 commits
# 568,365
torrent
Python
qbittor...
3 commits
# 501,491
Shell
C
acceler...
opencl
1 commit
# 167,335
slack
Shell
coffees...
ss13
1 commit
# 611,209
torrent
Python
qbittor...
1 commit
# 213,398
C#
indexer
sickrag...
Shell
1 commit
# 655,955
torrent
Python
qbittor...
1 commit

==================

python-qBittorrent

.. image:: https://readthedocs.org/projects/python-qbittorrent/badge/?version=latest :target: http://python-qbittorrent.readthedocs.org/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://badge.fury.io/py/python-qbittorrent.svg :target: https://badge.fury.io/py/python-qbittorrent

Python wrapper for qBittorrent Web API (for versions above 4.1, for version below and above v3.1.x please use 0.3.1 version).

For qBittorrent clients with earlier versions, use mookfist's

python-qbittorrent 
__.

This wrapper is based on the methods described in

qBittorrent's Official Web API Documentation 
__

Some methods are only supported in qBittorent's latest version (v3.3.1 when writing).

It'll be best if you upgrade your client to a latest version.

Installation

The best way is to install a stable release from PyPI::

$ pip install python-qbittorrent

You can also stay on the bleeding edge of the package::

$ git clone https://github.com/v1k45/python-qBittorrent.git
$ cd python-qBittorrent
$ python setup.py install

Prerequisite

qBittorent webUI must be enabled before using this API client.

How to enable the qBittorrent Web UI 
_

Quick usage guide

.. code-block:: python

from qbittorrent import Client

qb = Client('http://127.0.0.1:8080/')

qb.login('admin', 'your-secret-password')

not required when 'Bypass from localhost' setting is active.

defaults to admin:admin.

to use defaults, just do qb.login()

torrents = qb.torrents()

for torrent in torrents: print torrent['name']

If you have enabled SSL and are using a self-signed certificate, you'd probably want to disable SSL verification. This can be done by passing

verify=False
while initializing the
Client
.

.. code-block:: python

from qbittorrent import Client

qb = Client('https://127.0.0.1:8080/', verify=False)

API methods

Getting torrents

  • Get all

    active
    torrents::

    qb.torrents()

  • Filter torrents::

    qb.torrents(filter='downloading', category='my category')

    This will return all torrents which are currently

    downloading and are labeled as
    my category
    .

    qb.torrents(filter='paused', sort='ratio')

    This will return all paused torrents sorted by their Leech:Seed ratio.

Refer qBittorents WEB API documentation for all possible filters.

Downloading torrents

  • Download torrents by link::

    magnetlink = "magnet:?xt=urn:btih:e334ab9ddd91c10938a7....." qb.downloadfromlink(magnetlink)

    No matter the link is correct or not,

    method will always return empty JSON object.

  • Download multipe torrents by list of links::

    linklist = [link1, link2, link3] qb.downloadfromlink(linklist)

  • Downloading torrents by file::

    torrentfile = open('my-torrent-file.torrent', 'rb') qb.downloadfromfile(torrentfile)

  • Downloading multiple torrents by using files::

    torrentfilelist = [open('1.torrent', 'rb'), open('2.torrent', 'rb')] qb.downloadfromfile(torrentfilelist)

  • Specifing save path for downloads::

    dlpath = '/home/user/Downloads/special-dir/' qb.downloadfromfile(myfile, savepath=dlpath)

    same for links.

    qb.downloadfromlink(mymagneturi, savepath=dl_path)

  • Applying labels to downloads::

    qb.downloadfromfile(myfile, label='secret-files ;) ')

    same for links.

    qb.downloadfromlink(mymagneturi, category='anime')

Pause / Resume torrents

  • Pausing/ Resuming all torrents::

    qb.pauseall() qb.resumeall()

  • Pausing/ Resuming a speicific torrent::

    infohash = 'e334ab9ddd....infohash....5d7fff526cb4' qb.pause(infohash) qb.resume(info_hash)

  • Pausing/ Resuming multiple torrents::

    infohashlist = ['e334ab9ddd9......infohash......fff526cb4', 'c9dc36f46d9......infohash......90ebebc46', '4c859243615......infohash......8b1f20108']

    qb.pausemultiple(infohashlist) qb.resumemultipe(infohashlist)

Full API method documentation

All API methods of qBittorrent are mentioned @

Read the docs 
__

Authors

Maintainer

  • Vikas Yadav (v1k45) 
    __

Contributors

By chronological order

  • Matt Smith (psykzz) 
    __
  • Nicolas Wright (dozedoff) 
    __
  • sbivol 
    __
  • Christophe Ha (Shaance) 
    __
  • Your name here :)

TODO

  • Write tests

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.