mmpy_bot

ドキュメントは「Read the Docs」から入手できます。

説明

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 を利用している人もいるかもしれません。