Startseite
» Gewusst wie
»
Erstelle einen Matrix-Echo-Bot in Python mit Simple-Matrix-Bot-Lib
Erstelle einen Matrix-Echo-Bot in Python mit Simple-Matrix-Bot-Lib
Am 10. Oktober 2026 listete PyPI die Simple-Matrix-Bot-Lib 2.13.1, veröffentlicht am 29. März 2026. Das Paket benötigt Python 3.9 oder neuer, Python 3.9 wird jedoch nicht mehr unterstützt. Verwenden Sie stattdessen eine von dem Paket unterstützte, aktive Python-Version. Die Projektdokumentation auf PyPI ist noch als Version 2.11.0 gekennzeichnet und weist darauf hin, dass sie nicht mehr weiterentwickelt wird. Daher orientiert sich diese Anleitung am aktuellen PyPI-Beispiel für die Bot-API und verwendet das ältere Handbuch nur für eindeutig gekennzeichnete Konfigurationshinweise. Überprüfen Sie die Paketversion und die Metadaten auf PyPI . Lesen Sie den Dokumentationsstatus des Projekts .
Die schnellste und zuverlässigste Konfiguration besteht aus einem dedizierten Matrix-Benutzer, einer virtuellen Python-Umgebung und einem kleinen Echo-Bot, der !echoin einem Testraum antwortet. Das Beispiel bezieht sich auf einen unverschlüsselten Raum; für verschlüsselte Räume ist eine zusätzliche Konfiguration erforderlich.
Was benötigen Sie vor der Installation der Bibliothek?
Erstelle oder beantrage einen regulären Account auf dem Homeserver, auf dem der Bot ausgeführt werden soll. Vergib ihm einen eindeutigen Benutzernamen, z. B. „ echo_botBot-Benutzername“; er benötigt keine Homeserver-Administratorrechte. Die Registrierung kann vom Server deaktiviert oder eingeschränkt sein; beachte daher dessen Richtlinien zur Account-Erstellung. Lade den Account nur in einen privaten Testraum ein, in dem er Nachrichten senden darf.
Verwenden Sie Python 3.11 oder eine andere aktuell unterstützte Python-Version. Obwohl die Paketmetadaten noch Python 3.9 zulassen, stuft Python.org diese Version am 31. Oktober 2025 als nicht mehr unterstützt ein. Daher ist die im Paket angegebene Mindestversion keine empfehlenswerte Bereitstellungsempfehlung. Siehe auch den Hinweis von Python.org zur Unterstützung von Python 3.9 .
Wie installiert man Simple-Matrix-Bot-Lib?
Führen Sie diese Befehle in einem neuen Projektordner aus. Eine virtuelle Umgebung trennt die Pakete dieses Bots von anderen Python-Projekten. Die Versionsfixierung ermöglicht die Reproduzierbarkeit des Beispiels mit der neuesten, für diesen Artikel verifizierten Version. Beachten Sie beim Aktualisieren die aktuelle PyPI-Version und deren Kompatibilitätshinweise.
Aktivieren Sie unter Windows PowerShell die Umgebung mit dem Befehl .venv\Scripts\Activate.ps1`npm install` anstelle des sourceBefehls `npm install`. Erstellen Sie anschließend eine Datei mit dem Namen ` bot.py.py`. Die Projektseite von PyPI dokumentiert den Paketnamen und den Installationsbefehl. Das veröffentlichte Beispiel verwendet `npm install` Creds, Boteinen MessageListener und `npm install` MessageMatch. Siehe das aktuelle PyPI-Anwendungsbeispiel .
Das Terminal zeigt die isolierte Umgebung und die festgelegten Paketinstallationsbefehle für das Bot-Projekt an.
Wie verbindet man das Bot-Konto und fügt einen Befehl hinzu?
Speichern Sie die folgende Datei unter einem bot.pybestimmten Namen. Sie fordert beim Start das Bot-Passwort an, sodass dieses nicht in die Quelldatei geschrieben wird. Für die unbeaufsichtigte Bereitstellung von Diensten lesen Sie das Geheimnis aus dem Geheimnismanager Ihres Betriebssystems oder einer geschützten Umgebungsvariablen, anstatt es fest zu kodieren. Behandeln Sie jegliche Sitzungs- oder Zugriffstokenspeicherung, die von der Bibliothek erstellt wird, als Anmeldeinformationen: Halten Sie diese geheim und stellen Sie sicher, dass sie nicht in die Versionskontrolle gelangen.
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()
Ersetzen Sie die Beispiel-Homeserver-URL durch die Basis-URL Ihres Servers und verwenden Sie den Benutzernamen und das Passwort des Bot-Kontos. Der Listener empfängt Raumnachrichten, MessageMatchignoriert seine eigenen Nachrichten und verarbeitet nur den !echoBefehl. Der API-Aufruf sendet die restlichen Wörter zurück an denselben Raum. Diese Namen und Methodenaufrufe entsprechen dem veröffentlichten PyPI-Beispiel der Bibliothek. Vergleichen Sie mit der Kurzanleitung für Simple-Matrix-Bot-Lib .
Der Anmeldeinformationsblock verwendet ein dediziertes Konto und fordert dessen Passwort an, anstatt das Geheimnis in einer Datei zu speichern.Der Handler ignoriert die eigenen Nachrichten des Bots, gleicht den !echo-Befehl ab und sendet seine Argumente zurück an den Raum.
Wie startet man den Bot und stellt sicher, dass er funktioniert?
Führen Sie in der aktivierten virtuellen Umgebung folgenden Befehl aus:
python bot.py
Geben Sie das Bot-Kontopasswort ein, wenn Sie dazu aufgefordert werden. Senden Sie im Testraum eine !echo helloNachricht. Ein funktionierender Basis-Bot antwortet hello. Falls keine Antwort erfolgt, überprüfen Sie, ob das Bot-Konto dem Raum beigetreten ist, der Benutzer die Berechtigung zum Senden von Nachrichten hat, die Homeserver-URL korrekt ist und die Nachricht mit dem exakten !Präfix beginnt. Lassen Sie den Prozess weiterlaufen; das Schließen des Terminals beendet diese einfache Vordergrundbereitstellung.
Ein Beispiel für eine Raumkonversation zeigt die erwartete Anfrage und Antwort auf den Echo-Befehl; es handelt sich um eine Veranschaulichung, nicht um ein Live-Testergebnis.
Das Beispiel verarbeitet keine Ende-zu-Ende-verschlüsselten Raumnachrichten. Die Bibliothek wirbt zwar mit E2EE-Unterstützung, aber das zugehörige Handbuch ist mit Version 2.11.0 gekennzeichnet und möglicherweise veraltet. Es beschreibt zusätzliche matrix-nio[e2e]Abhängigkeiten und eine Config.encryption_enabledEinstellung. Prüfen Sie die genauen Installations- und Verifizierungsschritte für die von Ihnen installierte Version, bevor Sie die Verschlüsselung aktivieren. Die ältere Dokumentation beschreibt ebenfalls eine join_on_inviteEinstellung: Laden Sie den Bot nur zu Räumen ein, auf die er Zugriff haben soll, und aktivieren Sie diese Einstellung, wenn Ihre Bereitstellung automatische Raumbeitritte steuern muss. Lesen Sie das E2EE- und Konfigurationshandbuch der Bibliothek .
Die Einrichtung ist abgeschlossen, wenn der Bot angemeldet bleibt, Mitglied des Testraums ist und !echo hellomit „“ antwortet hello. Im Produktivbetrieb sollte er unter einem Prozessmanager ausgeführt und sein Passwort sowie seine Sitzungsdaten geschützt werden.