Skip to main content

Библиотека для разработки чат-ботов с помощью API мессенджера MAX

Project description

MaxAPI

ДокументацияПримерыMAX ЧатTG Чат

PyPI version Python Version License

● Установка из PyPi

Стабильная версия

pip install maxapi

● Установка из GitHub

Свежая версия, возможны баги. Рекомендуется только для ознакомления с новыми коммитами.

pip install git+https://github.com/love-apples/maxapi.git

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

Если вы тестируете бота в чате - не забудьте дать ему права администратора!

● Запуск Polling

Если у бота установлены подписки на Webhook - события не будут приходить при методе start_polling. При таком случае удалите подписки на Webhook через await bot.delete_webhook() перед start_polling.

import asyncio
import logging

from maxapi import Bot, Dispatcher
from maxapi.types import BotStarted, Command, MessageCreated

logging.basicConfig(level=logging.INFO)

# Внесите токен бота в переменную окружения MAX_BOT_TOKEN
# Не забудьте загрузить переменные из .env в os.environ
# или задайте его аргументом в Bot(token='...')
bot = Bot()
dp = Dispatcher()

# Ответ бота при нажатии на кнопку "Начать"
@dp.bot_started()
async def bot_started(event: BotStarted):
    await event.bot.send_message(
        chat_id=event.chat_id,
        text='Привет! Отправь мне /start'
    )

# Ответ бота на команду /start
@dp.message_created(Command('start'))
async def hello(event: MessageCreated):
    await event.message.answer(f"Пример чат-бота для MAX 💙")


async def main():
    await dp.start_polling(bot)


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

● Запуск Webhook

Перед запуском бота через Webhook, вам нужно установить дополнительные зависимости (fastapi, uvicorn). Можно это сделать через команду:

pip install maxapi[webhook]

Указан пример простого запуска, для более низкого уровня можете рассмотреть этот пример.

import asyncio
import logging

from maxapi import Bot, Dispatcher
from maxapi.types import BotStarted, Command, MessageCreated

logging.basicConfig(level=logging.INFO)

bot = Bot()
dp = Dispatcher()


# Команда /start боту
@dp.message_created(Command('start'))
async def hello(event: MessageCreated):
    await event.message.answer(f"Привет из вебхука!")


async def main():
    await dp.handle_webhook(
        bot=bot, 
        host='localhost',
        port=8080,
        log_level='critical' # Можно убрать для подробного логгирования
    )


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

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

maxapi-0.9.9.tar.gz (68.0 kB view details)

Uploaded Source

Built Distribution

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

maxapi-0.9.9-py3-none-any.whl (118.2 kB view details)

Uploaded Python 3

File details

Details for the file maxapi-0.9.9.tar.gz.

File metadata

  • Download URL: maxapi-0.9.9.tar.gz
  • Upload date:
  • Size: 68.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for maxapi-0.9.9.tar.gz
Algorithm Hash digest
SHA256 e5a9570f61e16cf25a6c549f0079165bf6ea1d34a81e02d22a92e5d848461d77
MD5 2025eab84a774e0dd5f2b2704dfd4743
BLAKE2b-256 07eb38c07c7de74bd70b3c5caef338e3bfeb334df4dc5857885b763243a0c09d

See more details on using hashes here.

Provenance

The following attestation bundles were made for maxapi-0.9.9.tar.gz:

Publisher: publish.yml on love-apples/maxapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file maxapi-0.9.9-py3-none-any.whl.

File metadata

  • Download URL: maxapi-0.9.9-py3-none-any.whl
  • Upload date:
  • Size: 118.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for maxapi-0.9.9-py3-none-any.whl
Algorithm Hash digest
SHA256 355179f8eb04bd18d1b3d169b7210e225c8cf0b8f01223c2fd955ad66e38e994
MD5 a2f807940b801cbf4142136ad054b68d
BLAKE2b-256 f69bd95a97a96b4e530815514e4a63f2fbd3382ae8487d77dc0c164991bfa3cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for maxapi-0.9.9-py3-none-any.whl:

Publisher: publish.yml on love-apples/maxapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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