Documentação disponível em Leia os documentos.
Uma estrutura de bot de bate-papo baseada em Python para Mattermost. O código para esta estrutura de bot foi fortemente reformulado na v2.0.0 e só funcionará com Python 3.8 ou superior. Para suporte a Python 2 e Python3 <3.8, use as versões v1.3.9 ou inferiores.
Mais importante | mmpy_bot |
---|---|
>= 4,0 | > 1.2.0 |
< 4,0 | sem suporte |
pip install mmpy-bot
pip install mmpy-bot==1.3.9
Primeiro você precisa criar uma conta de bot em seu servidor Mattermost. Nota: Habilitar criação de conta de bot deve estar habilitado no console do sistema
Observe que algumas funções da API, como respostas de mensagens efêmeras, exigirão que o bot faça parte do grupo Administrador do sistema ; no entanto, a maioria das funções da API funcionará com uma função de conta de membro regular. Esteja ciente de que se algumas funções da API não estiverem funcionando, pode ser devido à falta de permissões apropriadas.
Crie um arquivo de ponto de entrada (ou copie o fornecido), que defina o servidor Mattermost e as configurações da conta do bot e importe os módulos desejados.
Exemplo 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 ()
Defina o bit executável no arquivo do ponto de entrada (ou seja, chmod +x my_bot.py
) e inicie seu bot no prompt de comando. Agora você pode conversar com seu bot no cliente Mattermost!
Para aproveitar ao máximo seu bot, você precisará escrever seus próprios plug-ins. Consulte a documentação dos plug-ins para começar.
O principal canal de comunicação é o GitHub por meio de problemas ou solicitações pull, mas você também pode encontrar alguns de nós no Discord para alguma interação em tempo real.