Skip to content

MaxApiDevs/max-bot-aio-template

Repository files navigation

⚡️ MAX Bot AIO: The Golden Standard Template

Профессиональный Scaffold для разработки высоконагруженных систем на базе MAX Messenger API. Этот шаблон — фундамент «The Golden Standard» индустрии, ориентированный на System Design, Strict Typing и Zero-Downtime эксплуатацию.

⚡ AI-First & MAX API Native (Zero Blind Debugging)

99% туториалов и LLM-моделей галлюцинируют Telegram-структурами, что приводит к крашу кода в MAX API. Этот boilerplate решает проблему на уровне DX:

  • Real-World Payloads: Включает docs/MAX_API_Real_Payloads_2026.md — реверс-инжиниринг реальных ответов API, которых не хватает в официальной документации.
  • Встроенный AI-контекст: Благодаря встроенному .cursorrules, ваш ИИ-ассистент (Cursor/Copilot) автоматически использует правильные структуры MAX API. Вы генерируете строгие Pydantic-модели на основе реальных данных, а не догадок.

🏗 Architectural Core (The Anti-Spaghetti Manifesto)

Мы не пишем ботов, мы строим распределенные системы.

Layered Architecture: Полная изоляция бизнес-логики от транспорта (API) и инфраструктуры (DB/Cache).

Safety by Design: Pydantic V2 для тотальной валидации входящих Payload и конфигураций. Никаких dict.get().

Observability First: Встроенный экспорт метрик для Prometheus, структурированные JSON-логи и трассировка запросов.

Dependency Injection: Чистое управление компонентами без глобальных переменных.

🛠 Tech Stack & Infrastructure

Runtime: Python 3.12+ (Asyncio / UVLoop)

Framework: SQLAlchemy 2.0 (Async) + Alembic (Migrations)

State Management: Redis (Production) / In-Memory (Dev/Testing)

Delivery: Aiohttp Optimized Engine (Strict Typing for MAX API)

DevOps: Multi-stage Docker builds, Taskfile, GitHub Actions (CI/CD)

🚀 Quick Start (Production Grade)

  1. Подготовка окружения Bash

Клонирование с проверкой целостности

git clone https://github.com/your-org/max-bot-aio-template.git && cd max-bot-aio-template

Использование Taskfile (замена Makefile для DX)

task install cp .env.example .env 2. Конфигурация Отредактируйте .env. Мы используем Pydantic Settings, поэтому ошибка в одной переменной предотвратит запуск контейнера (Fail-fast).

  1. Запуск инфраструктуры Bash docker-compose up -d --build

📂 Project Structure (Scaffold)

Plaintext ├── cmd/ # Точки входа (App entrypoints) ├── internal/ # Приватный код (Business Logic) │ ├── delivery/ # Handlers, Middlewares (MAX API specific) │ ├── usecase/ # Pure Business Logic (Services) │ └── repository/ # Data Access Layer (SQLAlchemy/Redis) ├── pkg/ # Публичные библиотеки (Shared utils) ├── migrations/ # Alembic versioning ├── tests/ # Unit & Integration tests (Pytest + Mocks) └── Taskfile.yml # DX Command Center 📈 Observability & Quality Assurance Linter: Strict ruff & mypy (strict mode). Код, не прошедший статический анализ, в прод не попадает.

Metrics: /metrics эндпоинт для мониторинга RPS, Latency и ошибок API.

Mocks: Готовая стратегия мокирования внешних вызовов MAX API для тестов.

📑 Knowledge Base

В корне проекта находится MAX_API_Real_Payloads_2026.md. Это — «библия» реальных данных. Если API изменится, мы обновляем контракт здесь.

Need help or want to discuss MAX bot architecture?

Join our Dev Community: Max Chat: https://max.ru/join/xuOCxEvbn0nKepqaooBlHt35UZyvtwWwJoJLdeMzhy4

Releases

No releases published

Packages

 
 
 

Contributors