aiomax Documentation

Добро пожаловать в документацию aiomax — современного асинхронного фреймворка для создания ботов в мессенджере MAX.

📖 О проекте

aiomax — это мощный и гибкий фреймворк для разработки Telegram-подобных ботов с поддержкой:

✅ Асинхронности — построено на asyncio и aiohttp
✅ Диспетчеризации событий — удобные декораторы для обработки сообщений, callback и других событий
✅ Фильтров — гибкая система фильтрации по тексту, командам, чатам, пользователям и типу контента
✅ FSM (Finite State Machine) — управление состояниями для многошаговых диалогов
✅ Webhook и Polling — поддержка обоих режимов получения обновлений
✅ Типизации — полная типизация всех методов и моделей

🚀 Быстрый старт

import asyncio
from aiomax import Bot, F

bot = Bot(token="YOUR_TOKEN")

@bot.on_message(F.text.contains("привет"))
async def handle_hello(update):
    await bot.send_message(
        chat_id=update.message.recipient.chat_id,
        text="Привет! Как дела?"
    )

async def main():
    await bot.start()
    await bot.start_polling()
    await bot.close()

asyncio.run(main())

📚 Разделы документации

Руководства

Изучите основы работы с фреймворком:

Установка — установка библиотеки
Быстрый старт — первое знакомство
Long Polling — получение обновлений через опрос
Webhook — получение обновлений через вебхук
Обработчики — создание обработчиков событий
Фильтры — фильтрация обновлений
FSM — машина состояний для диалогов
Middleware — промежуточная обработка
Примеры — готовые примеры ботов

Модели данных

Описание структур данных:

Сообщение — модель сообщения
Чат — модель чата
Пользователь — модель пользователя
Обновление — модель обновления
Webhook — информация о вебхуке
Клавиатура — модели клавиатур
Вложения — типы вложений

API Методы

Документация по методам API:

Общие — базовые методы
Сообщения — работа с сообщениями
Чаты — управление чатами
Участники — управление участниками
Администраторы — права администраторов
Закрепления — закреплённые сообщения
Вебхуки — управление подписками

Перечисления (Enums)

Типы и константы:

🔗 Полезные ссылки

📞 Поддержка

Если у вас возникли вопросы или проблемы, создайте issue на GitHub или присоединяйтесь к нашему сообществу.