Metadata-Version: 2.4
Name: trackersremoverqbt
Version: 0.4.1
Summary: Automatically removes trackers from active qBittorrent downloads.
Author-email: Julien Minniti <minnitijulien06@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Jumitti/TrackersRemover-qBittorrent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: qbittorrent-api
Requires-Dist: rich
Dynamic: license-file

# TrackersRemover-qBittorrent 🗑️

![PyPI version](https://img.shields.io/pypi/v/trackersremoverqbt?label=PyPI%20Version) ![Monthly Downloads](https://img.shields.io/badge/dynamic/json?color=blue&label=Monthly%20Downloads&query=data.last_month&url=https%3A%2F%2Fpypistats.org%2Fapi%2Fpackages%2Ftrackersremoverqbt%2Frecent)

TrackersRemover-qBittorrent is a Python script that connects to qBittorrent's Web UI and removes trackers from torrents once their download speed exceeds a configurable threshold. This can help improve privacy or reduce reliance on certain trackers.

---

## Features

- Starts qBittorrent (Windows and macOS)
- Connects to qBittorrent Web UI via `qbittorrent-api`.
- Lists torrents and their trackers.
- Removes non-ignored trackers from torrents actively downloading above a minimum speed.
- Configurable ignored trackers list and minimum download speed threshold.
- 🍃 A beautiful new graphical interface in TKinter

---

## Installation via PyPI

1. **Start qBittorrent and configure qBittorrent Web UI**

2. **Install Python >=3.8 if it is not done**

3. **Open CMD (Terminal) and install the python package directly using pip:**

    ```bash
    pip install trackersremoverqbt
    ```

### Run in CMD
**Simply run it from the command line in CMD:**

 ```bash
 trackersremoverqbt
 # or
 trqbt
 ```

**Available options:**

```bash
# Exemple (works with trqbt instead of trackersremoverqbt)
trackersremoverqbt --host localhost --port 8080 --username admin --password 123456 --no-verify True --min-dl-speed 15 --launch-qbt True --ignored-trackers "tracker1.example.com" "tracker2.example.com"
# or
trackersremoverqbt -H localhost -P 8080 -U admin -PSW 123456 --no-verify True -MDL 15 -QBT True --ignored-trackers "tracker1.example.com" "tracker2.example.com"

# For version
trackersremoverqbt -V
# or
trackersremoverqbt --version

# For help
trackersremoverqbt --help
```

| Argument             | Alias(s) | Description                                               | Default Value                             |
|----------------------|----------|-----------------------------------------------------------|-------------------------------------------|
| `--host`             | `-H`     | qBittorrent Web UI address                                | `localhost`                               |
| `--port`             | `-P`     | Web UI port                                               | `8080`                                    |
| `--username`         | `-U`     | Web UI username                                           | `admin`                                   |
| `--password`         | `-PSW`   | Web UI password                                           | `123456`                                  |
| `--no-verify`        |          | Disable SSL certificate verification                      | `True` (verification disabled by default) |
| `--min-dl-speed`     | `-MDL`   | Minimum download speed in KB/s to trigger tracker removal | `10`                                      |
| `--ignored-trackers` |          | Additional list of trackers to ignore (added to defaults) | `[]` (empty by default)                   |
| `--launch-qbt`       | `-QBT`   | Launch qBittorrent if not running                         | `True`                                    |
| `--macmenu`          | `-MM`    | Display qBittorrent in Mac menu bar                       | `False`                                   |
| `--version`          | `-V`     | Show program version and exit                             |                                           |
| `--help`             |          | Show this help message and exit                           |                                           |
  
#### ⚠️ For [MacMenu-qBittorrent](https://github.com/Jumitti/MacMenu-qBittorrent)

All options related to [MacMenu-qBittorrent](https://github.com/Jumitti/MacMenu-qBittorrent) (```--macmenu``` and ``-MM``) are only enabled if you are using MacOS.

### Run with GUI (TKinter)

 ```bash
 trackersremoverqbt_tk
 # or
 trqbt_tk
 ```

All CLI arguments are available as function parameters.

---

### Run in python script

You can use `trackersremoverqbt` as a Python module instead of via command line:

#### Example

```python
from trackersremoverqbt.core import main as trqbt

trqbt(
    host="localhost",
    port=8080,
    username="admin",
    password="123456",
    no_verify=True,
    min_dl_speed=10,
    ignored_trackers=[
        "http://tracker.example.com/announce",
        "http://tracker.another.net/announce"
    ],
    launch_qbt=True,
   macmenu=False
)
```

All CLI arguments are available as function parameters.

---

#### Using a `whitelist_trackers.txt` file

If you have a list of trusted trackers in a file, you can load them like this:

##### `whitelist_trackers.txt` content:

```
http://tracker.example1.com/announce
http://tracker.example2.com/announce
http://tracker.example3.com/announce
http://tracker.another.net/announce
```

##### Example:

```python
from trackersremoverqbt.core import main as trqbt

# Load whitelist from file
with open("whitelist_trackers.txt", "r", encoding="utf-8") as f:
    whitelist = [line.strip() for line in f if line.strip()]

# Call main with whitelist
trqbt(ignored_trackers=whitelist)
```

## PoC
The script runs in a loop, periodically checking torrents and removing trackers that meet the criteria. It outputs a 
formatted table of torrents with their trackers and logs removal actions.

![alt text](img/login.png)

![alt text](img/torrent.png)

![alt text](img/remove.png)

![alt text](img/trqbt_tk.png)

![alt text](img/macmenu.png)

### Disclaimer

Removing trackers from torrents goes against the principles of traditional P2P sharing. By using this plugin, you acknowledge and agree:

- You understand the implications of modifying torrent behavior.
- You are solely responsible for any consequences that arise from using this plugin.
- The author(s) of TrackersRemover are not responsible for any misuse or unlawful use of this software.

## Notes

This tool is intended for advanced users aware of torrenting implications.

Tested on Python 3.12 and qBittorrent Web UI 5.x.
