errbot

Эррбот

Errbot — чат-бот. Он позволяет вам запускать сценарии в интерактивном режиме из ваших чатов по любой причине: случайный юмор, чаты, запуск сборки, мониторинг коммитов, запуск оповещений...

Он написан и легко расширяется на Python.

Errbot доступен как программное обеспечение с открытым исходным кодом и распространяется под лицензией GPL v3.

Функции

Поддержка чат-серверов

Встроенный

• IRC-поддержка
• Поддержка Телеграм
• Поддержка XMPP

С дополнениями

• Поддержка Slack (см. инструкции)
• Дискорд (см. инструкцию)
• Поддержка Gitter (см. инструкции)
• Webex (см. инструкции)
• Самое важное (см. инструкции)
• RocketChat (см. инструкции)
• Скайп (см. инструкцию)
• ТОКС (см. инструкции)
• ВК (Смотреть инструкцию)
• Зулип (см. инструкцию)

Администрация

После первоначальной установки и настройки безопасности Errbot можно администрировать, просто общаясь с ботом (чатопс).

• установить/удалить/обновить/включить/отключить частные или общедоступные плагины, размещенные на git
• плагины можно настроить из чата
• направить бота на присоединение к многопользовательским чатам (MUC) или выход из них
• Безопасность: функция управления ACL (права администратора/пользователя для каждой команды)
• резервное копирование: встроенная команда !backup создает полный экспорт сохраненных данных.
• журналы: можно просмотреть в чате или передать в Sentry.

Возможности разработчика

• Очень легко расширить возможности Python! (см. ниже)
• Предварительно настроенное хранилище для каждого плагина, т.е. self['foo'] = 'bar' сохраняет значение.
• Потоки разговора позволяют отслеживать состояния разговора от пользователей.
• Поддержка обратных вызовов вебхука
• поддерживает дополнительное форматирование уценки с таблицами, встроенными изображениями, ссылками и т. д.
• помощник по настройке, позволяющий настроить ваш плагин через чат
• Консоли разработки/отладки текста
• Самодокументирование: ваши строки документации автоматически становятся справочными.
• доступны подкоманды и различные параметры анализа аргументов (re, тип командной строки)
• поддержка опросов: вы можете настроить плагин, чтобы периодически что-то делать
• серверная часть сквозного тестирования
• рендеринг карточек в Slack

Сообщество и поддержка

Если у вас есть:

• небольшой вопрос, присоединяйтесь к нам в чате errbotio/errbot на Gitter.
• вопрос о разработке плагина, пожалуйста, используйте Stackoverflow с тегами errbot и python.
• об ошибке, о которой нужно сообщить, или запросе функции, воспользуйтесь нашей страницей проекта GitHub.

Вы также можете связаться с нами в Твиттере, используя хэштег #errbot .

Установка

Предварительные условия

Errbot работает под управлением Python 3.6+ на Linux, Windows и Mac. Для некоторых систем чата вам понадобится ключ или логин, чтобы ваш бот мог получить к ним доступ.

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

Мы рекомендуем настроить virtualenv.

1. Установить errbot из pip
2. Создайте где-нибудь каталог (здесь он называется errbot) для размещения файлов данных Errbot.
3. Инициализировать каталог
4. Попробуйте Errbot в текстовом режиме

$ pip install errbot
$ mkdir errbot ; cd errbot
$ errbot --init
$ errbot

Он покажет вам подсказку >>>, чтобы вы могли напрямую поговорить со своим ботом! Попробуйте !help, чтобы начать.

Добавление поддержки системы чата

Для встроенных модулей просто используйте один из этих вариантов Telegram, IRC, XMPP с pip, вы все равно можете сделать это после первоначальной установки, чтобы добавить недостающую поддержку, например.

 $ pip install "errbot[irc]"

Для внешних (Slack, Discord, Gitter, Skype и т. д.) следуйте инструкциям на соответствующих страницах GitHub.

Конфигурация

Чтобы настроить Errbot для подключения к одной из этих систем чата, вам необходимо настроить файл config.py, созданный errbot --init.

Чтобы помочь вам, у нас есть документированный шаблон, доступный здесь: config-template.py.

Примечание. даже если вы изменили BACKEND в конфигурации, вы все равно можете использовать errbot -T для локального тестирования вашего экземпляра в текстовом режиме.

Запуск Errbot как демона

Если все это сработало, теперь вы можете использовать параметр -d (или --daemon), чтобы запустить его в автономном режиме:

errbot --daemon

Взаимодействие с ботом

После запуска Errbot вам следует добавить бота в список друзей, если вы еще этого не сделали. Вам также потребуется явно пригласить бота в чаты в некоторых чат-системах. Теперь вы можете отправлять команды напрямую боту!

Чтобы получить список всех доступных команд, вы можете ввести:

 ! help

Если вы просто хотите узнать больше о конкретной команде, вы можете ввести:

 ! help command 

Управление плагинами

Вы можете управлять ботом в чате один на один, если ваш дескриптор есть в списке BOT_ADMINS в config.py.

Например, для поиска по ключевым словам в общедоступных репозиториях плагинов вы можете ввести:

 ! repos search jira

Чтобы установить плагин из этого списка, введите:

 ! repos install < name of repo >

Например, !repos install errbotio/err-imagebot.

Написание плагинов

Написание собственных плагинов чрезвычайно просто. errbot --init установит в подкаталог плагинов плагин под названием err-example, который вы можете использовать в качестве основы.

Например, это все, что нужно для создания «Привет, мир!» плагин для Errbot:

 from errbot import BotPlugin , botcmd

class Hello ( BotPlugin ):
    """Example 'Hello, world!' plugin for Errbot"""

    @ botcmd
    def hello ( self , msg , args ):
        """Return the phrase "Hello, world!" to you"""
        return "Hello, world!"

Этот плагин создаст команду «!hello», которая при запуске возвращает «Hello, world!» тебе. Дополнительную информацию обо всем, что вы можете делать с плагинами, можно найти в руководстве по разработке плагинов.

Вклад в сам Errbot

Не стесняйтесь создавать форки и предлагать изменения на github.