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的更改