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 中找到我們中的一些人進行一些即時互動。