Skip to main content

API library for qBittorrent with asyncio

Project description

aioqbt

Documentation Status

Python library for qBittorrent WebAPI with asyncio.

Features:

  • Async typed interfaces.
  • Complete qBittorrent WebAPI.
  • Tested with qBittorrent v4.1.5 to v4.6.0 on Debian/Ubuntu.

Documentation

https://aioqbt.readthedocs.io/en/latest/

Quick Start

Install with pip

$ pip install aioqbt
import asyncio

from aioqbt.api import InfoFilter
from aioqbt.client import create_client


async def main():
    client = await create_client(
        "http://localhost:8080/api/v2/",
        username="admin",
        password="adminadmin",
    )

    async with client:
        # print client and API versions
        print(await client.app.version())  # v4.6.1
        print(await client.app.webapi_version())  # 2.9.3

        # print torrents in downloading
        for info in await client.torrents.info(filter=InfoFilter.DOWNLOADING):
            print(f"{info.added_on.isoformat()} added {info.name!r}")
            # 2023-11-06T17:59:00 added 'ubuntu-22.04.3-desktop-amd64.iso'


if __name__ == '__main__':
    asyncio.run(main())

See detailed usage on Read the Docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aioqbt-0.7.1.tar.gz (87.1 kB view hashes)

Uploaded Source

Built Distribution

aioqbt-0.7.1-py3-none-any.whl (48.0 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