mmpy_bot
v2.1.4
Documentation disponible sur Read the Docs.
Un framework de chatbot basé sur Python pour Mattermost. Le code de ce framework de bot a été fortement remanié dans la v2.0.0 et ne fonctionnera qu'avec Python 3.8 ou supérieur. Pour la prise en charge de Python 2 et Python3 < 3.8, veuillez utiliser les versions v1.3.9 ou inférieures.
| Le plus important | mmpy_bot |
|---|---|
| >= 4,0 | > 1.2.0 |
| < 4,0 | non pris en charge |
pip install mmpy-bot
pip install mmpy-bot==1.3.9
Vous devez d'abord créer un compte bot sur votre serveur Mattermost. Remarque : Activer la création de compte Bot doit être activé sous la console système.
Notez que certaines fonctions de l'API, telles que les réponses aux messages éphémères, nécessiteront que le bot fasse partie du groupe Administrateur système . Cependant, la plupart des fonctions de l'API fonctionneront avec un rôle de compte membre standard. Sachez simplement que si certaines fonctions de l'API ne fonctionnent pas, cela peut être dû à un manque d'autorisations appropriées.
Créez un fichier de point d'entrée (ou copiez celui fourni), qui définit les paramètres de votre serveur Mattermost et de votre compte de bot et importe les modules souhaités.
Exemple 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 () Définissez le bit exécutable sur le fichier de point d'entrée (c'est-à-dire chmod +x my_bot.py ) et démarrez votre bot à partir de l'invite de commande. Vous pouvez désormais parler à votre bot dans votre client Mattermost !
Afin de tirer le meilleur parti de votre bot, vous devrez écrire vos propres plugins. Reportez-vous à la documentation des plugins pour commencer.
Le principal canal de communication est GitHub via des problèmes ou des demandes d'extraction, mais vous pouvez également trouver certains d'entre nous sur Discord pour une interaction en temps réel.
