README.md

Torrent Telegram Bot

What is this?

With torrent telegram bot, you can manage your Transmission or Qbittorrent torrent client. You can add, delete and list torrent entry.

To get started create config.yml file with your favourite text editor. Add your bot token ID, allowed user or chat ID (not username), torrent client url, username and password etc.

Installation

On most UNIX-like systems, you'll probably need to install python 3.11 or above and poetry. After that clone repository and install dependencies:

poetry install

Configuration

To customize bot, create config.yml, then add one or more of the variables. For an example, see config.example.yml in conf/ folder.

Usage

Create telegram bot with @BotFather. Create torrent telegram bot configuration file. And start you bot.

To start bot use command:

poetry run python -m torrent_telegram_bot.bot -c config.yml

Now you can start interacting with your bot.

Add torrent file to download queque

Just send torrent file to you bot and choose download category. The folder where the files will be uploaded depends on the category you select. The categories and folders that correspond to them are described in the configuration file.

List or delete torrent file

Just use reply keyboard button of bot:

⬇️List Downloading - List torrents with downloading status

📄List All - List all torrents

❌Delete - Delete torrent

Contributing

1. Check the open issues or open a new issue to start a discussion around your feature idea or the bug you found
2. Fork the repository and make your changes
3. Open a new pull request

If your PR has been waiting a while, feel free to ping me on Twitter.

Use this software often? 😃