Message Guardan

---

Message Guardian Bot is a Telegram bot designed to manage messages in groups, including saving messages, tracking changes, and restoring deleted messages. The bot is built using the Telethon framework for handling Telegram updates and SQLAlchemy for database interactions.

Table of Contents

• Installation
• Usage
• Project Structure
• License
• Contributors

Installation

1. Clone this repository:

git clone git@github.com/JM1k1/MessageGuardianBot.git

2. Cd into MessageGuardianBot:

cd MessageGuardianBot

3. Install Python 3.11+

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3 -y
sudo apt install python3-pip -y

4. Install Poetry:

curl -sSL https://install.python-poetry.org | python3 -

7. Install all dependencies:

poetry install

Usage

1. Configure your environment variables. Create a .env file in the root directory of the project and add the following:

TELEGRAM_TOKEN=YOUR_TOKEN
FORWARD_CHAT_ID=YOUR_FORWARD_CHAT_ID
DATABASE_ENGINE=sqlite+aiosqlite:///database.db

2. Initialize the database:

poetry run alembic upgrade head

3. Run the bot:

poetry run python /src/application.py

Project Structure

src

• application.py: Main entry point for running the bot.
• client.py: Configures and starts the Telethon client.

src/bot

• handlers.py: Handlers for processing different types of messages.
• logs/: Directory containing logs.

src/bot/core

• logger.py: Configures logging for the application.
• settings.py: Contains configuration settings, including the bot token.

src/bot/database

• crud.py: Contains CRUD operations for interacting with the database.
• database.py: Database setup and session management.
• models.py: SQLAlchemy models for the database schema.

src/bot/database/migrations

• env.py: Alembic environment configuration file.
• script.py.mako: Template for new migration scripts.
• versions/: Directory containing migration scripts.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributors

For anyone who is interested in contributing to MessageGuardianBot, please make sure you fork the project and make a pull request.