admin-scripts/list_torrents.py
2024-10-20 12:44:21 -05:00

68 lines
2.0 KiB
Python
Executable File

#!/usr/bin/env nix-shell
#! nix-shell -i python3 --packages python3 python312Packages.docopt
"""list_torrents.py
Description:
Fetch a list of torrents from a qBittorrent instance running on localhost.
The qBittorrent instance must be configured to allow login on localhost
without authentication. The output is formatted into a plaintext table.
Usage:
list_torrents.py
list_torrents.py -h
Options:
-h, --help show this help message and exit
"""
from docopt import docopt
from qbittorrent import Client
from tabulate import tabulate
# convert byte units
def human_bytes(input_bytes: int) -> str:
B = float(input_bytes)
KiB = float(1024)
MiB = float(KiB**2)
GiB = float(KiB**3)
TiB = float(KiB**4)
match B:
case B if B < KiB:
return "{0} {1}".format(B, "bytes" if 0 == B > 1 else "byte")
case B if KiB <= B <= MiB:
return "{0:.2f} KiB".format(B / KiB)
case B if MiB <= B <= GiB:
return "{0:.2f} MiB".format(B / MiB)
case B if GiB <= B <= TiB:
return "{0:.2f} GiB".format(B / GiB)
case B if TiB <= B:
return "{0:.2f} TiB".format(B / TiB)
case _:
return ""
def print_table():
qb = Client("http://localhost:8080/")
qb.login()
table = []
headers = ["Name", "Total Size", "Trackers Count", "Ratio", "Uploaded"]
sorted_torrents = sorted(qb.torrents(), key=lambda d: d["name"]) # type: ignore
for torrent in sorted_torrents:
row = []
row.append(torrent["name"]) # type: ignore
row.append(human_bytes(int(torrent["total_size"]))) # type: ignore
row.append(torrent["trackers_count"]) # type: ignore
row.append(torrent["ratio"]) # type: ignore
row.append(human_bytes(int(torrent["uploaded"]))) # type: ignore
table.append(row)
print(tabulate(table, headers, tablefmt="grid"))
if __name__ == "__main__":
args = docopt(__doc__) # type: ignore
print_table()