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.10.tar.gz (69.1 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.10-py3-none-any.whl (119.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: maxapi-0.9.10.tar.gz
  • Upload date:
  • Size: 69.1 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.10.tar.gz
Algorithm Hash digest
SHA256 e6a67b327a14869b4bf19a0b1cb8cf33aa7eb68bb08a5d8068c1915b407bfa03
MD5 c94248dd3cc68d7ef040ddd28ceec1fe
BLAKE2b-256 53696ea6052037ea2a52e5d2efc45617395838f9203a40e5318d792ee0c7c7b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for maxapi-0.9.10.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.10-py3-none-any.whl.

File metadata

  • Download URL: maxapi-0.9.10-py3-none-any.whl
  • Upload date:
  • Size: 119.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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 007a6f610e46ec33facf3a86496275befc7d4837a7385fc8f73b7aecdfac8f66
MD5 b0b1db23c6fc5b24fce462cada93341d
BLAKE2b-256 9dc52ead8b0ca14d52e3b7391be59babb376eeffd4ae6df9bb591f4564186798

See more details on using hashes here.

Provenance

The following attestation bundles were made for maxapi-0.9.10-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