Home
» Hoe
»
Bouw een Matrix Echo Bot in Python met Simple-Matrix-Bot-Lib.
Bouw een Matrix Echo Bot in Python met Simple-Matrix-Bot-Lib.
Op 10 oktober 2026 vermeldt PyPI Simple-Matrix-Bot-Lib 2.13.1, uitgebracht op 29 maart 2026. Het pakket vereist Python 3.9 of nieuwer, maar Python 3.9 heeft het einde van zijn levenscyclus bereikt; gebruik een onderhouden Python-versie die door het pakket wordt ondersteund. De documentatie van het gehoste project vermeldt nog steeds versie 2.11.0 en waarschuwt dat deze niet meer wordt onderhouden. Deze handleiding volgt daarom het huidige PyPI-voorbeeld voor de bot-API en gebruikt de oudere handleiding alleen voor duidelijk gelabelde configuratie-instructies. Controleer de pakketversie en metadata op PyPI . Lees de documentatiestatus van het project .
De snelste en meest betrouwbare configuratie bestaat uit een speciale Matrix-gebruiker, een virtuele Python-omgeving en een kleine echo-bot die reageert !echoin een testruimte. Dit voorbeeld is voor een niet-versleutelde ruimte; voor versleutelde ruimtes is extra configuratie nodig.
Wat heb je nodig voordat je de bibliotheek installeert?
Maak een regulier account aan op de homeserver waarop de bot zal draaien, of vraag er een aan. Geef het een unieke gebruikersnaam, bijvoorbeeld echo_bot; het heeft geen beheerdersrechten nodig. Registratie kan door die server zijn uitgeschakeld of beperkt, dus volg het beleid voor accountaanmaak. Nodig het account alleen uit voor een privé testruimte waar het berichten mag versturen.
Gebruik Python 3.11 of een andere momenteel ondersteunde Python-versie. Hoewel de pakketmetadata Python 3.9 nog steeds toestaat, geeft Python.org aan dat die versie vanaf 31 oktober 2025 niet meer ondersteund wordt. Daarom is de minimale versie die in het pakket wordt genoemd geen goede aanbeveling voor implementatie. Zie de ondersteuningsmelding voor Python 3.9 van Python.org .
Hoe installeer ik Simple-Matrix-Bot-Lib?
Voer deze commando's uit vanuit een nieuwe projectmap. Een virtuele omgeving zorgt ervoor dat de pakketten van deze bot gescheiden blijven van andere Python-projecten. De versieaanduiding zorgt ervoor dat het voorbeeld reproduceerbaar is met de meest recente release die voor dit artikel is geverifieerd; controleer bij het upgraden de huidige PyPI-release en de bijbehorende compatibiliteitsnotities.
Activeer de omgeving in Windows PowerShell met .venv\Scripts\Activate.ps1in plaats van de sourceopdracht. Maak vervolgens een bestand aan met de naam bot.py. De projectpagina van PyPI documenteert de pakketnaam en de installatieopdracht, en het gepubliceerde voorbeeld gebruikt Creds, Bot, een berichtlistener en MessageMatch. Zie het huidige gebruiksvoorbeeld op PyPI .
De terminal toont de geïsoleerde omgeving en de vastgezette installatieopdrachten voor pakketten voor het botproject.
Hoe verbind ik het botaccount en voeg ik een commando toe?
Sla het volgende op als bot.py. Het vraagt om het botwachtwoord bij het opstarten, dus het wachtwoord wordt niet in het bronbestand geschreven. Voor onbeheerde service-implementatie kunt u het geheim uitlezen uit de geheimenbeheerder van uw besturingssysteem of een beveiligde omgevingsvariabele in plaats van het vast te coderen. Beschouw alle sessie- of toegangstokenopslag die door de bibliotheek wordt aangemaakt als een referentie: houd deze privé en buiten versiebeheer.
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()
Vervang de voorbeeld-homeserver-URL door de basis-URL van uw server en gebruik de gebruikersnaam en het wachtwoord van het botaccount. De listener ontvangt berichten in de chatroom; MessageMatchhij zorgt ervoor dat hij zijn eigen berichten negeert en alleen het !echocommando verwerkt. De API-aanroep stuurt de resterende woorden terug naar diezelfde chatroom. Deze namen en methodeaanroepen volgen het gepubliceerde PyPI-voorbeeld van de bibliotheek. Vergelijk dit met de snelstartgids van Simple-Matrix-Bot-Lib .
Het inloggegevensblok maakt gebruik van een speciaal account en vraagt om het wachtwoord in plaats van het geheim in het bestand op te slaan.De handler negeert de eigen berichten van de bot, koppelt het !echo-commando eraan en stuurt de argumenten terug naar de chatroom.
Hoe start je de bot en hoe controleer je of hij werkt?
Voer vanuit de geactiveerde virtuele omgeving het volgende commando uit:
python bot.py
Voer het wachtwoord van het botaccount in wanneer daarom wordt gevraagd. Stuur in de testruimte een bericht !echo hello. Een werkende basisbot antwoordt met een bericht hello. Als de bot geen antwoord geeft, controleer dan of het botaccount zich bij die ruimte heeft aangesloten, of de gebruiker toestemming heeft om daar berichten te verzenden, of de URL van de homeserver correct is en of het bericht met het juiste !voorvoegsel begint. Laat het proces draaien; het sluiten van de terminal stopt deze eenvoudige implementatie op de voorgrond.
Een voorbeeldgesprek in een chatroom laat het verwachte verzoek en antwoord voor het echo-commando zien; het is een illustratie, geen resultaat van een live test.
Het voorbeeld verwerkt geen end-to-end versleutelde berichten in chatrooms. De bibliotheek adverteert met E2EE-ondersteuning, maar de huidige handleiding is gelabeld als versie 2.11.0 en is mogelijk verouderd; die handleiding beschrijft extra matrix-nio[e2e]afhankelijkheden en een Config.encryption_enabledinstelling. Controleer de exacte installatie- en verificatiestappen voor de versie die u installeert voordat u versleuteling inschakelt. De oudere documentatie beschrijft ook een join_on_inviteinstelling: nodig de bot alleen uit voor chatrooms waartoe hij toegang zou moeten hebben en vink die instelling aan als uw implementatie automatische deelname aan chatrooms moet beheren. Raadpleeg de E2EE- en configuratiehandleiding van de bibliotheek .
De installatie is voltooid wanneer de bot ingelogd blijft, lid is van de testruimte en antwoordt !echo hellomet hello. Voor productie kunt u de bot uitvoeren onder een procesmanager en het wachtwoord en de sessiegegevens beveiligen.