errbot

errbot

Errbot是聊天機器人。它允許您出於任何原因從聊天室進行交互啟動腳本：隨機幽默，聊天，啟動構建，監視提交，觸發警報...

它是在Python中寫的，很容易擴展。

ERRBOT可作為開源軟件可用，並根據GPL V3許可證發布。

特徵

聊天服務器支持

內建

• IRC支持
• 電報支持
• XMPP支持

與附加組件

• 鬆懈的支持（請參閱說明）
• 不和諧（請參閱說明）
• 吉特支持（請參閱說明）
• Webex（請參閱說明）
• 最重要（請參閱說明）
• Rocketchat（請參閱說明）
• Skype（請參閱說明）
• 毒品（請參閱說明）
• VK（請參閱說明）
• Zulip（請參閱說明）

行政

初始安裝和安全設置後，只需與機器人聊天（ChatOps）可以管理ERRBOT。

• 安裝/卸載/update/enable/disable/disable private或public插件託管在git上
• 可以通過聊天配置插件
• 指示機器人加入/離開多用戶聊天室（MUC）
• 安全性：ACL控制功能（每個命令的管理員/用戶權利）
• 備份：集成命令！備份創建了持久數據的完整導出。
• 日誌：可以從聊天中檢查或流式傳輸到哨兵。

開發人員功能

• 在Python中很容易擴展！ （見下文）
• 每個插件的預設存儲IE self['foo'] = 'bar'持續值。
• 對話流動以跟踪用戶的對話狀態。
• Webhook回調支持
• 支持使用表，嵌入式圖像，鏈接等的Markdown Extras格式化。
• 配置輔助器允許通過聊天配置插件
• 文本開發/調試控制台
• 自我記錄：您的文檔會自動幫助
• 可以使用子命令和各種ARG解析選項（RE，命令行類型）
• 投票支持：您可以設置插件以定期做某事
• 最終測試後端
• 放鬆下的卡片渲染

社區和支持

如果有：

• 一個快速的問題可以隨意加入我們在gitter上的errbotio/errbot上聊天。
• 插件開發問題，請使用標籤Errbot和Python使用Stackoverflow。
• 報告或功能請求的錯誤，請使用我們的GitHub項目頁面。

您還可以使用#errbot標籤上的Twitter上ping我們。

安裝

先決條件

errbot在Linux，Windows和Mac上的Python 3.6+下運行。對於某些聊天系統，您需要一個鍵或登錄機器才能訪問它。

Quickstart

我們建議設置Virtualenv。

1. 從PIP安裝ERRBOT
2. 在某個地方（此處稱為errbot）在託管errbot的數據文件中製作一個目錄
3. 初始化目錄
4. 在文本模式下嘗試errbot

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

它將向您顯示一個提示>>>，以便您可以直接與機器人交談！嘗試！幫助開始。

增加對聊天系統的支持

對於內置啟動，只需使用這些選項中的一個電報，IRC，XMPP與PIP，您仍然可以在初始安裝後進行添加缺失的支持，例如

$ pip安裝“ errbot [irc]”

對於外部（鬆弛，不和諧，吉特，Skype等），請按照其各自的GitHub頁面進行說明。

配置

為了配置errbot以連接到其中一個聊天系統之一，您需要調整errbot -init生成的config.py文件。

為了幫助您，我們在此處提供了一個已記錄的模板：config-template.py。

注意：即使您從配置更改了後端，您仍然可以使用ERRBOT -T在文本模式下在本地測試您的實例。

從守護程序開始Errbot

如果所有工作正常，您現在可以使用-d（或 - daemon）參數以獨立模式運行：

errbot --daemon

與機器人互動

啟動ERRBOT後，如果尚未將機器人添加到好友列表中。您也需要在某些聊天系統上明確邀請機器人到聊天室。您現在可以將命令直接發送到機器人！

要獲取所有可用命令的列表，您可以發行：

 ! help

如果您只想了解有關特定命令的更多信息，則可以發行：

 ! help command 

管理插件

如果您的句柄位於config.py中的bot_admins列表中，則可以在一對一聊天中管理機器人。

例如，要在公共插件存儲庫中進行關鍵字搜索您可以發行：

 ! repos search jira

要從此列表中安裝插件，請發行：

 ! repos install < name of repo >

例如！repos安裝errbotio/err-imagebot。

寫插件

編寫自己的插件非常簡單。 errbot - init將安裝在插件子目錄中的一個名為err-example的插件，您可以用作基礎。

例如，這就是創建“ Hello，World！”的全部內容。 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！”。給你。有關您可以使用插件的所有信息的更多信息，請參閱《插件開髮指南》。

對錯誤本身的貢獻

隨意叉，並提出對GitHub的更改