Simple-Matrix-Bot-Libを使用してPythonでMatrix Echo Botを構築する

2026 年 10 月 10 日現在、PyPI には Simple-Matrix-Bot-Lib 2.13.1 (リリース日: 2026 年 3 月 29 日) が掲載されています。このパッケージには Python 3.9 以降が必要ですが、Python 3.9 はサポートが終了しています。パッケージがサポートする、メンテナンスされている Python リリースを使用してください。ホストされているプロジェクトのドキュメントはまだバージョン 2.11.0 と表示され、メンテナンスされていないと警告されているため、このガイドではボット API の現在の PyPI の例に従い、古いマニュアルは明確にラベル付けされた設定メモにのみ使用します。PyPIでパッケージのリリースとメタデータを確認してください。プロジェクトのドキュメントのステータスをお読みください。

最も迅速で信頼性の高い設定は、専用のMatrixユーザー、Python仮想環境、およびテストルーム内で応答する小型のエコーボットです!echo。この例は暗号化されていないルームを想定しています。暗号化されたルームでは、追加の設定が必要です。

ライブラリをインストールする前に必要なものは何ですか?

ボットを実行するホームサーバー上に、通常のアカウントを作成またはリクエストしてください。ユーザー名は、例えば のようにecho_bot、固有のものにしてください。ホームサーバー管理者権限は必要ありません。サーバーによっては登録が無効または制限されている場合があるため、アカウント作成ポリシーに従ってください。アカウントは、メッセージの送信が許可されているプラ​​イベートテストルームにのみ招待してください。

Python 3.11 または現在サポートされている別の Python ブランチを使用してください。パッケージのメタデータでは Python 3.9 も許可されていますが、Python.org では 2025 年 10 月 31 日をもってそのブランチのサポートが終了するとされているため、パッケージの最小バージョンは適切なデプロイメントの推奨事項ではありません。Python.orgの Python 3.9 サポートに関する通知を参照してください。

Simple-Matrix-Bot-Libはどのようにインストールするのですか?

これらのコマンドは、新しいプロジェクトフォルダから実行してください。仮想環境を使用することで、このボットのパッケージを他のPythonプロジェクトから分離できます。バージョンピンは、この記事で検証済みの最新リリースに対してサンプルを再現可能にするためのものです。アップグレードする際は、最新のPyPIリリースとその互換性に関する注記を確認してください。

python3 --version
python3 -m venv .venv
source .venv/bin/activate
python -m pip install "simplematrixbotlib==2.13.1"

.venv\Scripts\Activate.ps1Windows PowerShell では、コマンドの代わりにを使用して環境をアクティブ化しますsource。次に、 という名前のファイルを作成しますbot.py。PyPI のプロジェクトページにはパッケージ名とインストールコマンドが記載されており、公開されている例ではCreds、 、Bot、メッセージリスナー、を使用していますMessageMatch。現在の PyPI の使用例を参照してください。

ターミナルコマンドを使用して、Python仮想環境を作成し、それをアクティブ化し、simplematrixbotlibバージョン2.13.1をインストールします。
ターミナルには、ボットプロジェクトの隔離された環境と、固定されたパッケージのインストールコマンドが表示されます。

ボットアカウントを接続してコマンドを追加するにはどうすればよいですか?

以下の内容を として保存してくださいbot.py。起動時にボットのパスワードの入力を求められるため、パスワードはソースファイルに書き込まれません。無人サービス展開の場合は、シークレットをハードコーディングする代わりに、オペレーティングシステムのシークレットマネージャまたは保護された環境変数から読み取ってください。ライブラリによって作成されたセッションまたはアクセストークンのストレージは認証情報として扱い、非公開にしてバージョン管理から除外してください。

import getpass
import simplematrixbotlib as botlib

creds = botlib.Creds(
    homeserver="https://matrix.example.org",
    username="echo_bot",
    password=getpass.getpass("Bot password: "),
)
bot = botlib.Bot(creds)
PREFIX = "!"

@bot.listener.on_message_event
async def echo(room, message):
    match = botlib.MessageMatch(room, message, bot, PREFIX)
    if (match.is_not_from_this_bot()
            and match.prefix()
            and match.command("echo")):
        text = " ".join(match.args())
        reply = text or "Usage: !echo <text>"
        await bot.api.send_text_message(room.room_id, reply)

bot.run()

サンプルホームサーバーの URL をサーバーのベース URL に置き換え、ボットのアカウントのユーザー名とパスワードを使用してください。リスナーはルームメッセージを受信し、MessageMatch自身のメッセージを無視して!echoコマンドのみを処理するようにします。API 呼び出しは残りの単語を同じルームに返します。これらの名前とメソッド呼び出しは、ライブラリの公開されている PyPI の例に従います。Simple -Matrix-Bot-Lib のクイックスタートと比較してください。

Pythonエディタには、インポート、getpassプロンプト、Matrixホームサーバーとecho_botの認証情報、およびボットの初期化が表示されます。
認証情報ブロックは専用アカウントを使用し、秘密情報をファイル内に配置する代わりに、そのアカウントのパスワードの入力を求めます。
on_message_eventリスナー、MessageMatchチェック、およびsend_text_message呼び出しを表示するPythonエディタ
ハンドラーはボット自身のメッセージを無視し、!echo コマンドに一致させ、その引数をルームに送り返します。

ボットを実行して、正常に動作することを確認するにはどうすればよいですか?

アクティブ化された仮想環境から、以下を実行します。

python bot.py

プロンプトが表示されたら、ボットアカウントのパスワードを入力してください。テストルームで、 を送信します!echo hello。正常に動作する基本的なボットは と返信しますhello。返信がない場合は、ボットアカウントがそのルームに参加していること、ユーザーがそこにメッセージを送信する権限を持っていること、ホームサーバーのURLが正しいこと、メッセージが正確な!プレフィックスで始まっていることを確認してください。プロセスは実行したままにしてください。ターミナルを閉じると、このシンプルなフォアグラウンド展開が停止します。

マトリックス形式のテストルームで、@you:example.org が !echo hello を送信し、@echo_bot:example.org が hello と応答する様子を示します。
サンプルルームの会話は、エコーコマンドに対する想定される要求と応答を示しています。これはあくまで例示であり、実際のテスト結果ではありません。

このサンプルはエンドツーエンド暗号化されたルームメッセージを処理しません。ライブラリはE2EEをサポートしていると謳っていますが、現在公開されているマニュアルはバージョン2.11.0であり、古い可能性があります。そのマニュアルには追加のmatrix-nio[e2e]依存関係とConfig.encryption_enabled設定が記載されています。暗号化を有効にする前に、インストールするバージョンの正確なインストール手順と検証手順を確認してください。古いドキュメントにはjoin_on_invite設定も記載されています。ボットがアクセスすべきルームにのみ招待し、デプロイメントで自動ルーム参加を制御する必要がある場合は、その設定を確認してください。ライブラリのE2EEと設定マニュアルを確認してください。

ボットがログイン状態を維持し、テストルームのメンバーであり、!echo helloかつ「」で応答するようになれば、セットアップは完了ですhello。本番環境では、プロセスマネージャの下で実行し、パスワードとセッションデータを保護してください。

コメントを残す

SynapseのSystemdファイル制限を推測なしで引き上げる

SynapseのSystemdファイル制限を推測なしで引き上げる

Synapseがプロセスごとのオープンファイル数の上限に達したかどうかを診断し、適切なサービスまたはワーカーに対してsystemdのドロップインを設定し、実際の制限を確認します。

要素に「復号化に失敗しました」と表示されますか?紛失したルームキーを復元してください。

要素に「復号化に失敗しました」と表示されますか?紛失したルームキーを復元してください。

エラーが特定のブラウザまたは特定のイベントに限定されているかどうかを確認し、残りの暗号化された履歴を危険にさらすことなく、Elementのリカバリキーまたは信頼できるデバイスを使用してください。

データを失うことなく、古いSynapseメッセージとメディアをクリーンアップする

Synapseの履歴およびメディア消去APIまたは保持設定を使用して、古いデータを安全に削除し、完了とディスク容量の回復を確認してください。

Simple-Matrix-Bot-Libを使用してPythonでMatrix Echo Botを構築する

Simple-Matrix-Bot-Libを使用してPythonでMatrix Echo Botを構築する

最新のライブラリをインストールし、専用のMatrixアカウントに接続して、より安全な認証情報処理と明確なテストを備えた小型の!echoボットを実行します。

MatrixをWhatsApp、Telegram、Discordに個別のブリッジで接続する

MatrixをWhatsApp、Telegram、Discordに個別のブリッジで接続する

登録、ログイン、テストをそれぞれ別々に行う3つのmautrixブリッジを設定することで、Dockerのネットワーク、アカウントポリシー、同期に関する予期せぬ問題を回避できます。

共有ファイルを破損させることなくSynapse Mediaのディスク容量を解放する

Synapseストレージを占有しているファイルを特定し、安全なメディア保持期間を設定し、ディスクから直接ファイルを削除することなくリモートキャッシュを消去します。

ルーム履歴を削除せずに、非アクティブなマトリックスユーザーを無効化する

ルーム履歴を削除せずに、非アクティブなマトリックスユーザーを無効化する

デバイスのアクティビティを確認し、Admin API を介して確認済みの非アクティブな Synapse アカウントを無効化し、オプションの消去フラグが実際に何を削除するのかを学びます。

Matrix SynapseにおけるPostgreSQLのメモリ負荷を軽減する

PostgreSQLのメモリがクエリ処理、共有バッファ、接続、メンテナンスのいずれに起因しているかを特定し、Synapseに安全な変更を的確に行います。

マトリックスシナプスルームの結合が遅い理由と、確認すべき点

マトリックスシナプスルームの結合が遅い理由と、確認すべき点

Synapseの設定を変更する前に、Matrixルームへの参加が遅い原因を、リモートホームサーバー、フェデレーションのバックオフ、ローカルデータベースの負荷、または送信キューのいずれかに特定してください。

SynapseでMatrixサインアップを閉鎖するか、招待トークンを必須にする

自己ホスト型のSynapseサーバーでの新規アカウント作成を停止するか、登録を招待制にし、使用回数に制限のある登録トークンを使用するようにしてください。