ziyodev-tg-bot 0.3.0

Aiogram frameworkida yozilgan Telegram bot shabloni generatori

Telegram Bot Template with Aiogram

This repository provides a template for building Telegram bots using the Aiogram framework in Python. It is designed to help you quickly start your bot development with a clean and modular structure.

Features

• Asynchronous Telegram Bot API with Aiogram
• Modular code organization
• Database integration utilities
• Easy to extend with custom handlers and commands

Installation

Option 1: Install via PyPI (Recommended 🚀)

You can install this template generator directly from PyPI:

pip install ziyodev-tg-bot

Once installed, you can generate a new bot project anywhere with a single command:

ziyodev-tg-bot init my-new-bot

This creates a new folder my-new-bot containing all the template structure. Then, simply:

cd my-new-bot
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
# Configure BOT_TOKEN and SECRET_KEY in src/.env
cd src
python manage.py migrate
python manage.py createsuperuser
python manage.py runbot

Option 2: Clone from GitHub

1. Clone the repository:

   git clone https://github.com/Ziyodullodev/telegram-bot-shablon-aiogram.git
   cd telegram-bot-shablon-aiogram
   

2. Create venv and run:

   python -m venv venv
   source venv/bin/activate
   pip install -r requirements.txt
   cp src/.env.example src/.env
   # Configure BOT_TOKEN and SECRET_KEY in src/.env
   cd src
   python manage.py migrate
   python manage.py createsuperuser
   python manage.py runbot
   

Configuration

Set your Telegram Bot Token in the environment or configuration file as needed.

Running the Bot

Run the bot with:

cd src
python manage.py runbot

Project Structure

• src/ - Django Backend & Bot Application
  • config/ - Django core configurations (settings.py, urls.py)
  • users/ - Custom User model, migrations, and django admin settings
  • bot/ - Aiogram Telegram Bot application
    • management/commands/runbot.py - Bot runner command
    • handlers/ - Bot handlers and keyboards
    • locales/ - Local JSON translation files synced dynamically via signals

Contributing

Contributions are welcome! Feel free to fork and submit pull requests.

License

MIT License

---

Happy bot building! 🚀