TransmissionPy

A CLI build with the Python cyclopts package.

Manage your Transmission torrents with Python!

Requirements

• uv
  • This project was built using uv.
  • If you install uv, you can run this app without worrying about dependencies. Just run uv run transmissionpy <--args>
• If you are not using uv, create a virtualenv (virtualenv .venv), activate it with . .venv/bin/activate (Linux/Mac) or . .venv\Scripts\activate (Windows), then run pip install -r requirements.txt

Usage

Run uv run transmissionpy --help to see help menu.

Help

Note: This help menu may be out of date. It's a good idea to run uv run transmissionpy --help to see the current args.

Usage: transmissionpy_cli COMMAND

CLI for transmissionpy Transmission RPC controller client.

╭─ Session Parameters ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --debug --no-debug  [default: False]                                                                                                                                                                             │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ torrent    Torrent management commands.                                                                                                                                                                          │
│ --help -h  Display this message and exit.                                                                                                                                                                        │
│ --version  Display application version.                                                                                                                                                                          │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Schedule cron job

On Linux, you can schedule jobs with cron, i.e. schedule the remove_finished_torrents.sh to run every 30 minutes.

• Run crontab -e to open the crontab editor
• Add a line to run the remove_finished_torrents.sh script every 30 minutes (note: this assumes the transmissionpy repository was cloned to ~//$HOME)

## crontab -e

## Run transmissionpy's remove_finished_torrents.sh script every 30 minutes
*/30 * * * * cd $HOME/transmissionpy && ./scripts/shell/remove_finished_torrents.sh