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 через MasterBot или через 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)

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.5.tar.gz (59.7 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.5-py3-none-any.whl (122.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: maxapi-0.9.5.tar.gz
  • Upload date:
  • Size: 59.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.0

File hashes

Hashes for maxapi-0.9.5.tar.gz
Algorithm Hash digest
SHA256 5b55e2969d920cc1d097e305d8b4c2e5d9410d3c019bd0421a64d0d618f61c7b
MD5 3d2e1ae301c1d5ca014ceace6594839b
BLAKE2b-256 afc709c9a74bca21875a33e27df8b34f7ececf19cf0d44de88c39ada76a26e42

See more details on using hashes here.

File details

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

File metadata

  • Download URL: maxapi-0.9.5-py3-none-any.whl
  • Upload date:
  • Size: 122.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.0

File hashes

Hashes for maxapi-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8b9a2b4bd620c66495feaaf136da971003e28be1a70943b8fc019aaefb064755
MD5 f8d81fca334777d067c4d3e2d4729650
BLAKE2b-256 8c5ac34cf4bc0a562b1a14bfa02c64595de587f759624c559d632d6c77d6fd85

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