Skip to main content

Асинхронный, модульный фреймворк для юзерботов в MAX Messenger

Project description

"The Official Pyromax Library (available on PyPI)".

Pyromax 🚀

Асинхронный, модульный и современный фреймворк для создания юзерботов в MAX Messenger.

Python Version License Status

Pyromax создан для тех, кто устал от "лапши" в одном файле. Мы перенесли лучшие практики из aiogram 3.x в мир MAX: роутеры, строгая типизация и удобная архитектура.

🔥 Почему Pyromax?

В отличие от других библиотек, мы ставим Developer Experience (DX) на первое место:

  • 📦 Система Роутеров (Routers): Разбивайте бота на файлы и плагины. Никаких файлов на 2000 строк.
  • ⚡ Скорость: Полностью асинхронное ядро на aiohttp и websockets.
  • clean_code: Архитектура, вдохновленная aiogram. Если вы писали ботов для Telegram, вы будете чувствовать себя как дома.
  • 🛠 Гибкость: Встроенный Dispatcher и Observer паттерн.

📦 Установка

Библиотека поддерживает современные менеджеры пакетов, включая uv.

Через pip

pip install pyromax

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

Простой эхо-бот:

import asyncio
import logging
import os
from pyromax.api import MaxApi
from pyromax.api.observer import Dispatcher as MaxDispatcher
from pyromax.types import Message

# Инициализация диспетчера
dp = MaxDispatcher()


# Регистрация хендлера (обрабатываем все сообщения, включая свои)
@dp.message(pattern=lambda update: True, from_me=True)
async def echo_handler(update: Message, max_api: MaxApi):
    # Отвечаем на сообщение тем же текстом и вложениями
    await update.reply(text=update.text, attaches=update.attaches)



async def main():
    logging.basicConfig(level=logging.INFO)

    # Создаем экземпляр API
    bot = await MaxApi()

    # Запускаем бота с диспетчером
    await bot.reload_if_connection_broke(dp)


if __name__ == "__main__":
    asyncio.run(main())

🧩 Модульность и Роутеры (Killer Feature)

1. Создайте модуль (например, handlers/admin.py)

from pyromax.api import MaxApi
from pyromax.api.observer import Router
from pyromax.filters import Command, CommandStart, CommandObject
from pyromax.types import Message

# Создаем отдельный роутер
router = Router()


# Регистрируем хендлер в роутер
@router.message(Command('ping'), from_me=True)
async def ping_handler(message: Message, max_api: MaxApi):
    await message.reply("Pong! 🏓")


@router.message(CommandStart())
async def start(message: Message):
    await message.answer(text='Ну начинаем?')
    
@router.message(Command('sum'), from_me=True)
async def sum_handler(message: Message, command: CommandObject) -> None:
    """
    В чате:
        >>>/sum 8 8
        
        >>>Ответ: 16
        
        
        >>>/sum 3 string
        
        >>>В аргументах могут быть только цифры
    """
    if command.args is None:
        return
    args = command.args.split()
    nums = []
    for arg in args:
        if not arg.isdigit():
            await message.reply(text = 'В аргументах могут быть только цифры')
            return
        nums.append(int(arg))
    await message.reply(text = f'Ответ: {sum(nums)}')

2. Подключите его в главном файле (main.py)

from pyromax.api.observer import Dispatcher as MaxDispatcher
from handlers.admin import router as admin_router


dp = MaxDispatcher()

# Подключаем роутер к главному диспетчеру
dp.include_router(admin_router)
# ... далее запуск бота как в примере выше

Теперь ваш код чист, структурирован и легко масштабируется!

🗺 Roadmap (Планы развития)

Мы активно развиваем библиотеку и стремимся сделать её стандартом для MAX.

📍 Текущий статус (Alpha)

  • Core: Полностью асинхронное ядро (MaxApi, Dispatcher).
  • Routers: Модульная система (разбиение бота на файлы).
  • Types: Строгая типизация всех объектов (Update, Message, Attachments).
  • Observer: Система паттернов и фильтров для хендлеров.

🚧 В разработке

  • FSM (Finite State Machine): Машина состояний для создания сценариев (опросы, диалоги, формы).
  • Middlewares: Перехват событий до хендлеров (логирование, анти-флуд, базы данных).
  • Magic Filters: Удобный синтаксис фильтров (как F.text.startswith("!")).

🔮 Планы на будущее

  • Документация: Полноценный сайт с документацией и примерами.
  • Плагины: Готовые модули для администрирования чатов.

📞 Контакты

Telegram разработчика: ТЫК

🤝 Contributing

Мы рады любой помощи! Если вы хотите предложить фичу или исправить баг:

  1. Форкните репозиторий.
  2. Создайте ветку (git checkout -b feature/NewFeature).
  3. Откройте Pull Request.

📄 Лицензия

MIT License. Свободно используйте в своих проектах.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyromax-0.5.1.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyromax-0.5.1-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

Details for the file pyromax-0.5.1.tar.gz.

File metadata

  • Download URL: pyromax-0.5.1.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for pyromax-0.5.1.tar.gz
Algorithm Hash digest
SHA256 05afddb63cb033093cacb60f1428df54ce926f94089d3b84c085efe8c6dd81d2
MD5 7c8e96b183d9f61da0a7af62e730627a
BLAKE2b-256 a1b002658e0f5fd649db865d7d67f8b5c9339f22ee282827b09e2129c956d278

See more details on using hashes here.

File details

Details for the file pyromax-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: pyromax-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 33.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for pyromax-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e94f5ebf76a540a5dbaf3e2a8e4f5f1eb0605884794782bec5e01f8ef83a0d3a
MD5 fefbaa26f67b0371b3af94d18ec25149
BLAKE2b-256 8c3da2be827fc6562ff4f02777d5d1cf5212543f77c74b36fb7ca1607b92b8ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page