Skip to main content

macOS menu bar app to show qBittorrent torrents status.

Project description

MacMenu-qBittorrent 🍏

PyPI version

MacMenu-qBittorrent is a lightweight macOS menu bar app that connects to qBittorrent's Web UI and displays active torrents with their progress and other stuff directly in your Mac menu bar.


Features

  • Runs natively on macOS as a menu bar application.
  • Connects to qBittorrent Web UI via qbittorrent-api.
  • Displays all active torrents with progress percentages and many other stuff in the menu bar.
  • Configuration displaying
  • Auto-refreshes torrent status at configurable intervals.
  • Configurable connection parameters (host, port, username, password).
  • Simple and clean UI using rumps.

Installation via PyPI

  1. Ensure you have Python >=3.8 installed on your Mac

  2. Install the package from PyPI

    pip install macmenuqbt
    

Usage from the command line

Run the app from your terminal (or create a shortcut) — this will start the menu bar app:

macmenuqbt
# or the alias
mmqbt

Available options:

macmenuqbt --host localhost --port 8080 --username admin --password 123456 --interval 5
Argument Alias(s) Description Default Value
--host -H qBittorrent Web UI host localhost
--port -P qBittorrent Web UI port 8080
--username -U qBittorrent Web UI username admin
--password -PSW qBittorrent Web UI password 123456
--interval -I Update interval in seconds 5
--version -V Show program version and exit
--help Show this help message and exit

For help and version:

macmenuqbt --help
macmenuqbt --version

Usage as a Python module

You can also embed Menubar-qBittorrent in your own Python scripts by calling its main() function with parameters:

from macmenuqbt.core import main as mmqbt

mmqbt(
    host="localhost",
    port=8080,
    username="admin",
    password="123456",
    interval=5
)

Screenshot and hints

  • This is the default view: alt text

  • Status table (see also screenshot):

    Status Emoji Description
    downloading ⬇️ Downloading
    resumed ⬇️ Download resumed
    running ⬇️ Running / in progress
    forcedDL ⬇️ Forced download
    seeding 🌱 Seeding (uploading)
    completed Download completed
    paused ⏸️ Paused
    stopped ⏸️ Stopped
    inactive ⏸️ Inactive
    active 🔄 Active / operation in progress
    stalled ⚠️ Stalled / waiting
    stalled_uploading ⚠️ Upload stalled
    stalled_downloading ⚠️ Download stalled
    checking 🔍 Checking files
    moving 📦 Moving files
    errored Error encountered
    all 📋 All torrents
    unknown Unknown status

    alt text

  • All options enabled:

    Simply click on them to activate them. alt text

  • Change the order as you wish:

    alt text alt text

Notes

Only compatible with macOS due to use of rumps for menu bar integration.

Tested with Python 3.8+ and qBittorrent Web UI 5.x.

Requires qBittorrent Web UI to be enabled and accessible.

Disclaimer

This tool only displays torrent information; it does not modify or control qBittorrent.

Contributing

Feel free to open issues or submit pull requests!

Another qBittorrent plugin

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

macmenuqbt-0.1.4.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

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

macmenuqbt-0.1.4-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file macmenuqbt-0.1.4.tar.gz.

File metadata

  • Download URL: macmenuqbt-0.1.4.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for macmenuqbt-0.1.4.tar.gz
Algorithm Hash digest
SHA256 a5a1dbca7f5166b44a3e5d385025fc5f89fd9c35a5fb1ec171902b593bc36d63
MD5 f8eab6d76bb384993558e2c5a927f279
BLAKE2b-256 3277d4415d20020d4003e30f9ffa8b55d53a63ada9ea8c4edd306a9ef420f63a

See more details on using hashes here.

File details

Details for the file macmenuqbt-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: macmenuqbt-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for macmenuqbt-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 15bc6c68b71906071fe7c849b4ea15684157aaaae4b60cc00579523092cf6416
MD5 e38851a92ee58745ae5da27cd492d737
BLAKE2b-256 298cbe1cbe0d0a4d732d04b6b78eff5ab6011212ef5bfad6f6608cbecdfb64dc

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