README.md

Telegram Bot Template

Easily replicate consistent telegram bot structure and functionality with this Telegram bot template.

Features Include:

Restricted Access to the Bot Using a Whitelist/Blacklist
MySQL Database Connection for User Data
Logger Handles Console and File Logging

---

Table of Contents

1. Setup
2. Bot Commands

Setup

1. Ensure that you have Python 3.9+ install on your machine. If not, you can install it here.

2. Add additional functionality to the bot by customizing the template.

3. Modify the database_schema file to reflect your desired user data/configuration.

4. Add your new commands to bot_commands.txt.

5. Set config variables in tg_config.py file and db_config.py file

6. Install pip packages

   pip install -r requirements.txt

7. Run the Telegram bot from the entrypoint

   python main.py

(back to top)

Bot Commands:

View Commands Documentation Here

(back to top)