Skip to content

Latest commit

 

History

History
227 lines (167 loc) · 6.95 KB

README.md

File metadata and controls

227 lines (167 loc) · 6.95 KB

🛠️ Kernel Telegram Bot

A modular Telegram bot powered by python-telegram-bot.
This bot is designed for scalability, maintainability, and follows clean architecture principles.

🚀 Features

  • Uses python-telegram-bot for handling Telegram interactions.
  • Structured with SOLID principles for modularity.
  • Poetry-based dependency management (previously Pipenv).
  • Built-in error handling and logging.
  • Uses environment variables (.env) to store sensitive data.

📌 Upcoming Enhancements & Next Steps

We are actively improving the kernel to be more reusable, scalable, and efficient. The following enhancements are planned:

  • Short-Term Goals

    • Support for Webhooks: Implement run_webhook() to allow event-driven execution.
    • Testing with SQLite: Create unit tests using pytest for config_loader.py, database.py, and handlers.
    • Verify PostgreSQL Integration: Ensure database compatibility with PostgreSQL.

  • Mid-Term Goals

    • Plugin System for Dynamic Modules: Load new commands automatically from bot/plugins/.
    • Multi-language Support (i18n): Implement a translation system with JSON-based locales.
    • Message Middleware: Filter messages before they reach command handlers.

  • Long-Term Goals

    • Redis Caching for Performance Optimization: Store user sessions in memory for faster responses.
    • External API Integration: Create api_client.py for connecting with third-party services.
    • WebSockets for Real-Time Events: Enable instant notifications and live event handling.
    • Admin Dashboard with FastAPI: Develop an API to manage and monitor the bot remotely.

📦 Installation & Setup

1️⃣ Install Poetry

Poetry is used to manage dependencies and virtual environments:

pip install poetry

2️⃣ Install Project Dependencies

poetry install

3️⃣ Configure Environment Variables

Create a .env file in the project root and add your Telegram Bot Token:

# TOKEN
TELEGRAM_BOT_TOKEN=your_actual_bot_token_here
# Add Telegram user IDs separated by commas
AUTHORIZED_USERS=12345678,98765432

# Change as needed
# LOG_LEVEL=DEBUG # Shows detailed information for debugging.
# LOG_LEVEL=INFO # Shows general information about program operation.
LOG_LEVEL=WARNING # Shows warnings about potential problems.
# LOG_LEVEL=ERROR # Shows errors that prevent correct operation.

DEBUG_MODE=False

# Options: DATABASE_TYPE sqlite or postgres

# If using SQLite:
DATABASE_TYPE=sqlite

# If using PostgreSQL: (Upcoming)
# DATABASE_TYPE=postgres  

# Only required if using PostgreSQL
# DATABASE_URL=postgresql://user:password@localhost:5432/mydatabase

DATABASE_FILE=bot_database.db

▶️ Running the Bot

You can start the bot in two ways:

1️⃣ Using Poetry

poetry run python bot/main.py

2️⃣ Using the run.sh Script

Make sure run.sh is executable:

chmod +x run.sh
./run.sh

3️⃣ Using Webhooks (Coming Soon)

poetry run python bot/main.py --webhook

🛠️ Project Structure

kernel-telegram-bot/
│── bot/                      # Main application logic
│   ├── __init__.py           # Package init file
│   ├── main.py               # Entry point of the bot
│   │
│   ├── handlers/             # Telegram command handlers
│   │   ├── __init__.py       # Package init file
│   │   ├── start.py          # /start command
│   │   ├── help.py           # /help command
│   │   ├── unknown.py        # Unknown command handler
│   │   ├── errors.py         # Error handling
│   │
│   ├── services/             # Business logic (auth, db, etc.)
│   │   ├── __init__.py       # Package init file
│   │   ├── auth.py           # Manages user authentication & permissions.
│   │   ├── database.py       # Handles data storage (SQLite/PostgreSQL).
│   │   ├── cache.py          # (Upcoming) Redis-based caching (for faster performance)
│   │   ├── api_client.py     # (Upcoming) Handles API integrations (with external APIs)
│   │
│   ├── utils/                # Utility functions (config, logging)
│   │   ├── __init__.py       # Package init file
│   │   ├── config_loader.py  # Load config files or .env
│   │   ├── logger.py         # Logging setup
│   │   ├── middleware.py     # (Upcoming) Preprocess messages before reaching handlers (spam filtering, normalization)
│   │
│   ├── plugins/              # (Upcoming) Dynamic plugin modules)
│   ├── locales/              # (Upcoming) Multi-language support
│   ├── dashboard/            # (Upcoming) FastAPI-based admin panel
│   ├── config.py             # Main bot configuration
│
├── tests/                    # Unit and integration tests
│   ├── test_config.py        # Tests for config loader
│   ├── test_database.py      # Tests for database functionality
│   ├── test_handlers.py      # Tests for bot command handlers
│
├── docs/                     # Documentation files
│   ├── SETUP.md              # Setup guide
│   ├── TESTING.md            # Testing guide
│   ├── DEPLOYMENT.md         # Deployment instructions
│
├── .gitignore                # Git ignore rules
├── .env                      # Environment variables
├── LICENSE                   # License file
├── README.md                 # Project documentation
├── CODE_OF_CONDUCT.md        # Code of conduct for contributors
├── AUTHORS.md                # List of contributors
├── CONTRIBUTING.md           # Contribution guidelines
├── pyproject.toml            # Poetry configuration
├── poetry.lock               # Poetry dependencies
└── run.sh                    # Script to run the bot

**🧪 Running Tests

To run unit tests:

poetry run pytest

**🛠️ Development & Contribution

Fork this repository.

Clone your fork:

git clone https://github.com/LoboGuardian/kernel-telegram-bot.git

Install dependencies:

poetry install

Create a feature branch:

git checkout -b feature/new-feature

Make changes and commit:

git commit -m "Added a new feature"
Push and create a pull request.

⚖️ License

This project is licensed under the GPL-3.0 License. See the LICENSE file for details.

🤝 Credits & Contact

🚀 Contribution & Future Development

We welcome contributions! Our current focus areas include:

  • Expanding testing coverage.

  • Optimizing database performance.

  • Enhancing real-time event handling with WebSockets.

  • If you want to contribute, fork the repo and submit a PR.

Feel free to discuss improvements via GitHub Issues.