maxapi-python 2.0.1

Python wrapper для API мессенджера Max

PyMax

Python-библиотека для Max API.

[!WARNING] PyMax использует неофициальный внутренний API Max. API может измениться без предупреждения, а использование библиотеки может нарушать условия сервиса. Вы используете PyMax на свой риск; авторы и контрибьюторы не несут ответственности за блокировки аккаунтов, потерю данных или другие последствия.

Что это

PyMax - асинхронная Python-библиотека для внутреннего API Max. Она умеет авторизоваться в аккаунте, слушать события, отправлять сообщения, работать с чатами, пользователями, файлами, сессиями и доменными типами Max через TCP или WebSocket.

Возможности

• Авторизация по телефону и SMS-коду через Client.
• QR-авторизация web-клиента через WebClient.
• Роутеры, фильтры, on_start, raw-события и typed events.
• Сообщения: отправка, ответы, reply, реакции, pin, read, delete и история.
• Чаты, группы, участники, invite-ссылки и настройки групп.
• Пользователи, контакты, профиль, папки, активные сессии и 2FA.
• Вложения: Photo, File, Video.
• SQLite-сессии, sync-state, reconnect и debug-логи.
• Pydantic-модели и удобные domain-объекты.

Установка

Требуется Python 3.10 или новее.

pip install -U maxapi-python

Через uv:

uv add -U maxapi-python

Напрямую из репозитория:

pip install git+https://github.com/MaxApiTeam/PyMax.git

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

Client использует TCP-соединение. При первом запуске PyMax попросит SMS-код и сохранит сессию в SQLite-файл; дальше этот файл используется автоматически.

import asyncio

from pymax import Client, Message

client = Client(
    phone="[phone]",
    work_dir="cache",
    session_name="main.db",
)


@client.on_start()
async def on_start(client: Client) -> None:
    print("Клиент запущен")
    print("Ваш ID:", client.me.contact.id if client.me else "unknown")


@client.on_message()
async def on_message(message: Message, client: Client) -> None:
    print(message.chat_id, message.sender, message.text)

    if message.chat_id is not None and message.text:
        await message.answer("Привет от PyMax")


async def main() -> None:
    await client.start()


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

WebClient

WebClient использует WebSocket и QR-авторизацию:

import asyncio

from pymax import WebClient

client = WebClient(work_dir="cache", session_name="web.db")


@client.on_start()
async def on_start(client: WebClient) -> None:
    print("Web-клиент запущен")


asyncio.run(client.start())

Роутеры

Обработчики можно регистрировать на клиенте или вынести в отдельный роутер. Handler всегда принимает событие и клиента: (event, client).

from pymax import Client, ClientRouter, Message

router = ClientRouter()


def is_start(message: Message) -> bool:
    return message.text == "/start"


@router.on_message(is_start)
async def start(message: Message, client: Client) -> None:
    await message.answer("Готово")


client = Client(phone="[phone]", work_dir="cache")
client.include_router(router)

Куда дальше

• Getting Started - первый запуск и сессии.
• Client - жизненный цикл клиента, reconnect и sync-state.
• Router - роутеры, фильтры и raw events.
• Messages - сообщения, реакции, история и вложения.
• Files - отправка и скачивание файлов.
• FAQ и Troubleshooting - частые проблемы.

Опубликованная документация:

• docs.pymax.org
• DeepWiki

Разработка

uv sync --all-groups
uv run python -c "import pymax; print(pymax.__all__)"
uv run sphinx-build -b html docs docs/_build/html

Ссылки

• GitHub
• PyPI
• Telegram

Лицензия

Проект распространяется под лицензией MIT. Подробности см. в LICENSE.

Авторы

• ink - основной разработчик, исследование API и документация.
• noxzion - оригинальный автор проекта.