Шаблон Telegram бота

Описание

Шаблон проекта для создания Telegram бота с использованием архитектуры чистого кода (Clean Architecture), SQLAlchemy для работы с базой данных и Alembic для миграций.

Структура проекта

tgbot_template_v3
├── src
│   └── app
│       ├── application    # Бизнес-логика приложения
│       │   ├── gateway    # Интерфейсы для работы с внешними сервисами
│       │   └── usecases   # Сценарии использования
│       ├── bootstrap      # Инициализация приложения
│       ├── domain         # Доменная модель
│       ├── infrastructure # Внешние сервисы и инфраструктура
│       └── presentation   # Слой представления
├── .env                   # Переменные окружения
├── .env.dist             # Шаблон переменных окружения
├── alembic.ini           # Конфигурация Alembic

Требования

• Python 3.11.5
• virtualenv

Установка и настройка

1. Клонируйте репозиторий:

git clone <url_репозитория>
cd tgbot_template_v3

2. Создайте и активируйте виртуальное окружение:

python -m venv .venv

# Для Windows
.venv\Scripts\activate

# Для Linux/MacOS
source .venv/bin/activate

3. Установите зависимости:

pip install .

4. Создайте файл с переменными окружения:

cp .env.dist .env

5. Отредактируйте файл .env, заполнив все необходимые поля.

Настройка базы данных

1. Создайте начальную миграцию:

alembic revision --autogenerate

2. Примените миграции:

alembic upgrade head

Запуск бота

make run.bot

Разработка

При внесении изменений в модели данных не забывайте создавать и применять миграции:

alembic revision --autogenerate -m "описание изменений"
alembic upgrade head