mmpy_bot
v2.1.4
Documentación disponible en Lea los documentos.
Un marco de chat bot basado en Python para Mattermost. El código para este marco de bot se refactorizó en gran medida en la versión 2.0.0 y solo funcionará con Python 3.8 o superior. Para compatibilidad con Python 2 y Python3 < 3.8, utilice las versiones v1.3.9 o inferiores.
| lo más importante | mmpy_bot |
|---|---|
| >= 4.0 | > 1.2.0 |
| < 4.0 | sin apoyo |
pip install mmpy-bot
pip install mmpy-bot==1.3.9
Primero necesitas crear una cuenta de bot en tu servidor Mattermost. Nota: Habilitar la creación de cuentas de bot debe estar habilitado en la Consola del sistema
Tenga en cuenta que algunas funciones de API, como las respuestas a mensajes efímeros, requerirán que el bot forme parte del grupo de administradores del sistema ; sin embargo, la mayoría de las funciones de API funcionarán con una función de cuenta de miembro normal. Sólo tenga en cuenta que si algunas funciones de la API no funcionan, puede deberse a la falta de los permisos adecuados.
Cree un archivo de punto de entrada (o copie el proporcionado), que defina la configuración de su servidor Mattermost y de su cuenta de bot e importe los módulos deseados.
Ejemplo 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 () Configure el bit ejecutable en el archivo de punto de entrada (es decir, chmod +x my_bot.py ) e inicie su bot desde el símbolo del sistema. ¡Ahora puedes hablar con tu bot en tu cliente Mattermost!
Para aprovechar al máximo su bot, deberá escribir sus propios complementos. Consulte la documentación de complementos para comenzar.
El canal principal de comunicación es GitHub a través de problemas o solicitudes de extracción, pero también puede encontrarnos a algunos de nosotros en Discord para interactuar en tiempo real.
