tman

Torrent manager enables you to download / seed your torrents on your own schedule.

project status badges:

version badges:

Installation 🗹

Using pipx to Install (preferred)

This package could be installed using pip like any other Python package (in fact, see the section below this one for instructions on how to do just that). Given that we only need this package's entry points, however, we recommend that pipx be used instead:

# install and setup pipx
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# install tman
pipx install torrent-manager

Using pip to Install

To install tman using pip, run the following commands in your terminal:

python3 -m pip install --user torrent-manager  # install tman

If you don't have pip installed, this Python installation guide can guide you through the process.

Command-Line Interface (CLI)

The output from running tman --help is shown below:

usage: tman [-h] [-c CONFIG_FILE] [-L [FILE[:LEVEL][@FORMAT]]] [-v]
            {start,add} ...

Don't have a good day. Have a great day.

optional arguments:
  -c CONFIG_FILE, --config CONFIG_FILE
                        Absolute or relative path to a YAML file that contains
                        this application's configuration.
  -h, --help            show this help message and exit
  -L [FILE[:LEVEL][@FORMAT]], --log [FILE[:LEVEL][@FORMAT]]
                        This option can be used to enable a new logging
                        handler. FILE should be either a path to a logfile or
                        one of the following special file types: [1] 'stderr'
                        to log to standard error (enabled by default), [2]
                        'stdout' to log to standard out, [3] 'null' to disable
                        all console (e.g. stderr) handlers, or [4] '+[NAME]'
                        to choose a default logfile path (where NAME is an
                        optional basename for the logfile). LEVEL can be any
                        valid log level (i.e. one of ['CRITICAL', 'DEBUG',
                        'ERROR', 'INFO', 'TRACE', 'WARNING']) and FORMAT can
                        be any valid log format (i.e. one of ['color', 'json',
                        'nocolor']). NOTE: This option can be specified
                        multiple times and has a default argument of '+'.
  -v, --verbose         How verbose should the output be? This option can be
                        specified multiple times (e.g. -v, -vv, -vvv, ...).

subcommands:
  {start,add}
    start               Start the system's torrent service, add any missing
                        torrents to it (i.e. torrents added via `tman add
                        ...`), wait configured amount of time, and then
                        shutdown the system torrent service we started
                        earlier.
    add                 Qeueue new torrent to download next time `tman start`
                        is run.

Useful Links 🔗

• API Reference: A developer's reference of the API exposed by this project.
• cc-python: The cookiecutter that was used to generate this project. Changes made to this cookiecutter are periodically synced with this project using cruft.
• CHANGELOG.md: We use this file to document all notable changes made to this project.
• CONTRIBUTING.md: This document contains guidelines for developers interested in contributing to this project.
• Create a New Issue: Create a new GitHub issue for this project.
• Documentation: This project's full documentation.