errbot

埃博特

Errbot 是一个聊天机器人。它允许您出于任何原因从聊天室交互式启动脚本：随机幽默、chatops、开始构建、监控提交、触发警报...

它是用 Python 编写的并且可以轻松扩展。

Errbot 作为开源软件提供，并根据 GPL v3 许可证发布。

特征

聊天服务器支持

内置

• IRC 支持
• 电报支持
• XMPP 支持

带有附加组件

• Slack 支持（参见说明）
• 不和谐（参见说明）
• Gitter 支持（参见说明）
• Webex（参见说明）
• 最重要（参见说明）
• RocketChat（参见说明）
• Skype（参见说明）
• TOX（参见说明）
• VK（参见说明）
• Zulip（参见说明）

行政

初始安装和安全设置后，只需与机器人 (chatops) 聊天即可管理 Errbot。

• 安装/卸载/更新/启用/禁用 git 上托管的私有或公共插件
• 可以通过聊天配置插件
• 指示机器人加入/离开多用户聊天室 (MUC)
• 安全性：ACL控制功能（每个命令的管理员/用户权限）
• backup：集成命令 !backup 创建持久数据的完整导出。
• 日志：可以从聊天中检查或传输到 Sentry。

开发者功能

• 用Python 很容易扩展！ （见下文）
• 每个插件的预设存储即self['foo'] = 'bar'保留该值。
• 对话流用于跟踪用户的对话状态。
• Webhook 回调支持
• 支持带有表格、嵌入图像、链接等的 Markdown Extras 格式。
• 配置助手，允许通过聊天配置您的插件
• 文本开发/调试控制台
• 自记录：您的文档字符串自动成为帮助
• 可以使用子命令和各种 arg 解析选项（re，命令行类型）
• 轮询支持：您可以设置一个插件来定期执行某些操作
• 端到端测试后端
• Slack下的卡片渲染

社区和支持

如果您有：

• 有一个简单的问题，请随时加入我们在 Gitter 上的 errbotio/errbot 的聊天室。
• 插件开发问题请使用带有 errbot 和 python 标签的 Stackoverflow。
• 要报告错误或功能请求，请使用我们的 GitHub 项目页面。

您还可以在 Twitter 上使用主题标签#errbot联系我们。

安装

先决条件

Errbot 在 Linux、Windows 和 Mac 上的 Python 3.6+ 下运行。对于某些聊天系统，您的机器人需要密钥或登录名才能访问它。

快速入门

我们建议设置一个 virtualenv。

1. 从 pip 安装 errbot
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 连接到这些聊天系统之一，您需要调整 errbot --init 生成的 config.py 文件。

为了帮助您，我们在这里提供了一个文档化的模板：config-template.py。

注意：即使您更改了配置中的 BACKEND，您仍然可以使用 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!”给你。有关插件功能的更多信息，请参阅插件开发指南。

对 Errbot 本身的贡献

请随意在 github 上 fork 并提出更改