irispy 1.1.1

Async and fast api wrapper for IrisCallback API

IrisPY

Асинхронная и быстрая библиотека для Iris Callback API.

С помощью Iris Callback API вы можете получать сигналы из бесед, на которые вы подписались. Это поможет вам обрабатывать информацию способом, который удобен для вас без каких-либо ограничений.

Для этого необходимо создать свой сервер, который будет принимать запросы от серверов Iris.

Установка

1. Новейшая версия:
   pip install irispy==1.1

2. С помощью установщика pip из GitHub:
   pip install https://github.com/zpodushkin/irispy/archive/master.zip --upgrade

Кастомизация

После установки irispy рекомендуется сразу же установить дополнительные модули loguru и vbml.
С ними фреймворк работает лучше и быстрее.

Установите loguru и vbml с помощью команд:

pip install loguru
pip install vbml

Примеры использования

from irispy import Dispatcher
from irispy import objects

dp = Dispatcher(secret="<your_secret>", user_id=0)


@dp.event.sendMySignal(text=["test", "hello"])
async def wrapper(event: objects.SendMySignal):
    """ Функция, которая ловит сигнал
    при отправке сообщений: .с; !сигнал ...
    :param event: Объект эвента
    :return:
    """
    print(event.object)


@dp.event.sendSignal(text="скажи <text>")
async def executor(event: objects.SendSignal, text: str):
    print(text)


@dp.event.bindChat()
async def bind(event: objects.BindChat):
    print(event.object.chat)

dp.run_app(host="0.0.0.0", port=8080)

Больше примеров в папке /examples

Документация

• Iris Callback API 2.0 (Статья)
• Подробная информация по посадке
• Язык разметки VBML (Документация)

История релизов

• 1.0
  • Первый деплой!
• 1.0.1
  • Добавление логов и обработка ошибок
• 1.0.5
  • Валидация в методах sendSignal и sendMySignal
  • Изменение структуры хендлеров
• 1.1
  • Валидаторы VBML!
  • Первый и официальный релиз!
• 1.1.1
  • Не работали валидаторы без аргументов. Исправлено
  • Модуль «IrisPY» был загружен на PyPi!

Contributing

ПР поддерживаются! Мне приятно видеть ваш вклад в развитие библиотеки
Задавайте вопросы в блоке issues и в чате VK!

Лицензия

Copyright © 2019-2020 zpodushkin.
Этот проект имеет GPL-3.0 лицензию.