97 lines
2.6 KiB
Markdown
97 lines
2.6 KiB
Markdown
# Асинхронный MAX API
|
||
|
||
[](https://pypi.org/project/maxapi/)
|
||
[](https://pypi.org/project/maxapi/)
|
||
[](https://love-apples/maxapi/blob/main/LICENSE)
|
||
|
||
---
|
||
|
||
## 📦 Установка
|
||
|
||
```bash
|
||
pip install maxapi
|
||
```
|
||
|
||
---
|
||
|
||
## 🚀 Быстрый старт
|
||
|
||
Если вы тестируете бота в чате - не забудьте дать ему права администратора!
|
||
|
||
```python
|
||
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'
|
||
)
|
||
|
||
|
||
@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())
|
||
```
|
||
|
||
---
|
||
|
||
## 📚 Документация
|
||
|
||
В разработке...
|
||
|
||
---
|
||
|
||
## ⭐️ Примеры
|
||
|
||
- [Эхо бот](https://love-apples/maxapi/blob/main/examples/echo/main.py)
|
||
- [Обработчик доступных событий](https://love-apples/maxapi/blob/main/examples/events/main.py)
|
||
- [Обработчики с MagicFilter](https://love-apples/maxapi/blob/main/examples/magic_filters/main.py)
|
||
- [Демонстрация роутинга, InputMedia и механика контекста](https://love-apples/maxapi/blob/main/examples/router_with_input_media/main.py) (audio.mp3 для команды /media)
|
||
|
||
---
|
||
|
||
|
||
## 🧩 Возможности
|
||
|
||
- ✅ Роутеры
|
||
- ✅ Билдер инлайн клавиатур
|
||
- ✅ Простая загрузка медиафайлов
|
||
- ✅ MagicFilter
|
||
- ✅ Внутренние функции моделей
|
||
- ✅ Контекстный менеджер
|
||
- ✅ Поллинг
|
||
- ✅ Вебхук
|
||
- ✅ Логгирование
|
||
|
||
---
|
||
|
||
|
||
## 💬 Обратная связь и поддержка
|
||
|
||
- MAX: [Чат](https://max.ru/join/IPAok63C3vFqbWTFdutMUtjmrAkGqO56YeAN7iyDfc8)
|
||
- Telegram: [@loveappless](https://t.me/loveappless)
|
||
---
|
||
|
||
## 📄 Лицензия
|
||
|
||
Этот проект распространяется под лицензией MIT. См. файл [LICENSE](LICENSE) для подробностей.
|