Accueil
» Comment faire
»
Créez un robot Matrix Echo en Python avec Simple-Matrix-Bot-Lib
Créez un robot Matrix Echo en Python avec Simple-Matrix-Bot-Lib
Au 10 octobre 2026, PyPI répertorie Simple-Matrix-Bot-Lib 2.13.1, publié le 29 mars 2026. Ce paquet requiert Python 3.9 ou une version ultérieure, mais Python 3.9 n'est plus maintenu ; utilisez une version de Python maintenue et compatible avec le paquet. La documentation du projet hébergée indique toujours la version 2.11.0 et précise qu'elle n'est plus maintenue. Ce guide suit donc l'exemple actuel de l'API du bot sur PyPI et n'utilise l'ancien manuel que pour les notes de configuration clairement identifiées. Consultez la version et les métadonnées du paquet sur PyPI . Lisez l'état de la documentation du projet .
La configuration la plus rapide et fiable consiste en un utilisateur Matrix dédié, un environnement virtuel Python et un petit robot d'écho qui répond !echodans une salle de test. Cet exemple concerne une salle non chiffrée ; les salles chiffrées nécessitent une configuration supplémentaire.
De quoi avez-vous besoin avant d'installer la bibliothèque ?
Créez ou demandez un compte standard sur le serveur d'hébergement qui hébergera le bot. Attribuez-lui un nom d'utilisateur unique, par exempleecho_bot ; il n'a pas besoin de privilèges d'administrateur. L'inscription peut être désactivée ou restreinte par ce serveur ; veuillez donc respecter sa politique de création de compte. Invitez ce compte uniquement dans un salon de test privé où il sera autorisé à envoyer des messages.
Utilisez Python 3.11 ou une autre version de Python actuellement prise en charge. Bien que les métadonnées du paquet autorisent encore Python 3.9, Python.org indique que cette version ne sera plus maintenue à compter du 31 octobre 2025 ; par conséquent, la version minimale requise pour ce paquet n’est pas recommandée pour un déploiement. Consultez l’avis de Python.org concernant la prise en charge de Python 3.9 .
Comment installer Simple-Matrix-Bot-Lib ?
Exécutez ces commandes depuis un nouveau dossier de projet. Un environnement virtuel permet de séparer les paquets de ce bot des autres projets Python. Le verrouillage de version garantit la reproductibilité de l'exemple avec la dernière version vérifiée pour cet article ; lors d'une mise à jour, consultez la version PyPI actuelle et ses notes de compatibilité.
Sous Windows PowerShell, activez l'environnement avec `pip install` .venv\Scripts\Activate.ps1au lieu de la sourcecommande `pip install`. Créez ensuite un fichier nommé ` bot.py.py`. La page du projet sur PyPI documente le nom du package et la commande d'installation, et son exemple publié utilise `pip install`, `pip install` Creds, Botun écouteur de messages et `pip install` MessageMatch. Consultez l'exemple d'utilisation actuel sur PyPI .
Le terminal affiche l'environnement isolé et les commandes d'installation des paquets épinglées pour le projet de bot.
Comment connecter le compte du bot et ajouter une commande ?
Enregistrez le fichier suivant sous le nom bot.py. Il vous demandera le mot de passe du bot au démarrage ; celui-ci n'est donc pas écrit dans le fichier source. Pour un déploiement de service automatisé, lisez le secret depuis le gestionnaire de secrets de votre système d'exploitation ou une variable d'environnement protégée au lieu de l'intégrer directement dans le code. Considérez tout stockage de session ou de jeton d'accès créé par la bibliothèque comme une information d'identification : conservez-le confidentiel et ne l'intégrez pas au système de contrôle de version.
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()
Remplacez l'URL du serveur d'accueil d'exemple par l'URL de base de votre serveur et utilisez le nom d'utilisateur et le mot de passe du compte du bot. Le processus reçoit les messages de la salle ; MessageMatchil ignore ses propres messages et ne traite que la !echocommande. L'appel API renvoie les messages restants dans cette même salle. Ces noms et appels de méthode sont conformes à l'exemple publié sur PyPI. Comparez avec le guide de démarrage rapide de Simple-Matrix-Bot-Lib .
Le bloc d'identification utilise un compte dédié et demande son mot de passe au lieu de placer le secret dans le fichier.Le gestionnaire ignore les messages du bot, correspond à la commande !echo et renvoie ses arguments à la salle.
Comment lancer le bot et vérifier son bon fonctionnement ?
Depuis l'environnement virtuel activé, exécutez :
python bot.py
Saisissez le mot de passe du compte bot lorsque vous y êtes invité. Dans le salon de test, envoyez un message !echo hello. Un bot basique fonctionnel répond hello. S'il ne répond pas, vérifiez que le compte bot a bien rejoint ce salon, que l'utilisateur est autorisé à y envoyer des messages, que l'URL du serveur principal est correcte et que le message commence par le !préfixe exact. Laissez le processus en cours d'exécution ; la fermeture de son terminal interrompt ce déploiement simple au premier plan.
La conversation d'exemple ci-dessous illustre la requête et la réponse attendues pour la commande echo ; il s'agit d'une illustration et non d'un résultat de test en direct.
L'exemple ne traite pas les messages chiffrés de bout en bout dans les salons. La bibliothèque annonce la prise en charge du chiffrement de bout en bout, mais sa documentation actuelle (version 2.11.0) est potentiellement obsolète ; elle décrit matrix-nio[e2e]des dépendances supplémentaires et un Config.encryption_enabledparamètre. Avant d'activer le chiffrement, vérifiez scrupuleusement la procédure d'installation et de vérification de la version que vous installez. Les anciennes documentations mentionnent également un join_on_inviteparamètre : invitez le bot uniquement aux salons auxquels il est autorisé à accéder et vérifiez ce paramètre si votre déploiement doit contrôler les entrées automatiques dans les salons. Consultez la documentation relative au chiffrement de bout en bout et à la configuration de la bibliothèque .
La configuration est terminée lorsque le bot reste connecté, est membre de la salle de test et répond !echo hellocorrectement hello. Pour la production, exécutez-le sous un gestionnaire de processus et protégez son mot de passe et ses données de session.