mmpy_bot

文档可在阅读文档中找到。

描述

Mattermost 的基于 Python 的聊天机器人框架。该机器人框架的代码在 v2.0.0 中进行了大量重构，并且仅适用于 Python 3.8 或更高版本。对于 Python 2 和 Python3 < 3.8 支持，请使用 v1.3.9 或更低版本。

特征

• 基于Mattermost WebSocket API(V4.0.0)
• 简单的插件机制
• 并发消息处理
• 附件支持
• 连接丢失后自动重新连接到 Mattermost

v2.x 中添加的附加功能：

• 多线程和异步执行
• 集成 Webhook 服务器
• 支持点击功能
• 作业调度

兼容性

最重要的	mmpy_bot
>= 4.0	> 1.2.0
< 4.0	不支持的

安装

️警告：如果你的 Python 版本低于 3.8，pip 将获取 v1.x！

v2.x（最新）

 pip install mmpy-bot

v1.3.9（强制遗留）

 pip install mmpy-bot==1.3.9

用法 (v2.x)

登记

首先，您需要在 Mattermost 服务器上创建一个机器人帐户。注意：必须在系统控制台下启用启用机器人帐户创建

1. 以具有管理权限的用户身份登录您的 Mattermost 服务器。
2. 导航到集成 -> 机器人帐户 -> 添加机器人帐户
3. 填写配置选项，并在创建时记下访问令牌

请注意，某些 API 功能（例如临时消息回复）将要求机器人成为系统管理员组的一部分，但大多数 API 功能将与常规会员帐户角色一起使用。请注意，如果某些 API 功能无法正常工作，可能是由于缺乏适当的权限。

配置并运行机器人

创建一个入口点文件（或复制提供的文件），该文件定义您的 Mattermost 服务器和机器人帐户设置并导入所需的模块。

示例my_bot.py ：

 #!/usr/bin/env python

from mmpy_bot import Bot , Settings
from my_plugin import MyPlugin

bot = Bot (
    settings = Settings (
        MATTERMOST_URL = "http://chat.example.com" ,
        MATTERMOST_PORT = 443 ,
        BOT_TOKEN = "a69155mvlsobcnqpfdceqihaa" ,
        BOT_TEAM = "test" ,
        SSL_VERIFY = True ,
    ),  # Either specify your settings here or as environment variables.
    plugins = [ MyPlugin ()],  # Add your own plugins here.
)
bot . run ()

在入口点文件上设置可执行位（即chmod +x my_bot.py ）并从命令提示符启动机器人。现在您可以在 Mattermost 客户端中与您的机器人交谈！

为了充分利用您的机器人，您需要编写自己的插件。请参阅插件文档以开始使用。

与我们交谈

主要的沟通渠道是 GitHub，通过问题或拉取请求，但您也可能会在 Discord 中找到我们中的一些人进行一些实时交互。