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)
# ... далее запуск бота как в примере выше

New: Теперь можно использовать форматирование текста в ответе

@dp.message(Command('lyric'), from_me=True)
async def lyric(msg: Message):
    await msg.answer(text='<STRONG>They tell me, "keep it simple"</STRONG>'
                             '<QUOTE>I tell them, "take it slow"</QUOTE>'
                             '<STRIKETHROUGH>I feed a water an idea so I let it grow </STRIKETHROUGH> \n'
                             '<UNDERLINE>I tell them, "take it easy"</UNDERLINE> \n'
                             '<EMPHASIZED>They laugh and tell me, "No"</EMPHASIZED> \n')

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

🗺 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.4.tar.gz (30.9 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.4-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyromax-0.5.4.tar.gz
Algorithm Hash digest
SHA256 844e6825cf8864b428cd25586a4bb20e14589cc619d2440f0284d9d5ae42e29f
MD5 4a822656731f3bab112ee0fd4b11f752
BLAKE2b-256 77947004c92b985ccfcee12749cc9809b4e42838f05e6172d6de9b16baf17c02

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyromax-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 05bb0ab1667aa4b415936e2e713a40f9181961443e917c833f1b32bb0a2d5830
MD5 bc666e850638b350181db39dcedc73be
BLAKE2b-256 ea75bd922b6b7e5133edecc8a9340f1bee2029f289c1d0ab8c1448a91ba17d7b

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