Skip to content

Files

Latest commit

2a22d50 · May 19, 2023

History

History
51 lines (32 loc) · 1.94 KB

README.md

File metadata and controls

51 lines (32 loc) · 1.94 KB

Cobrador del Frac Bot

Simple dockerized python Telegram Bot to remind your colleagues to pay their debts.

Buy Me A Coffee

Requirements

Getting Started

Telegram Bot creation

The only configuration required in order to get started is to create a .env file with your Telegram Bot Token (TELEGRAM_TOKEN), the Chat IDs where you intend to use it (TELEGRAM_CHATS), and the User IDs you want to set as Admins for your new Bot, to access configuration functions (TELEGRAM_ADMINS). For the last two configuration variables, even if there's just one ID, make sure to pass them as arrays.

If you don't have a Telegram Token yet, you'll need one through Telegram's BotFather. See details on Bot creation here.

Configuration

Now that we have a Telegram Token for our bot, the configuration is as easy as:

$ echo "TELEGRAM_TOKEN=0123456789:AbCd1e2f3G..." >> .env
$ echo "TELEGRAM_CHATS=[1111,2222]" >> .env
$ echo "TELEGRAM_ADMINS=[3333]" >> .env

Usage

Deployment

To deploy this Bot in your own environment after configuring the Telegram Token, you just have to execute:

$ docker-compose up -d

Built With

  • Python - The programming language that lets you work quickly and integrate systems more effectively.

Authors

  • Carles Llobet - Complete work - Github

See also the list of contributors who participated in this project.

Acknowledgments