A python based chat bot for MatterMost (http://www.mattermost.org).
Documentation available at Read the Docs.
A python based chat bot for Mattermost.
| Mattermost | mmpy_bot | |------------------|:-----------:| | >= 4.0 | > 1.2.0 | | < 4.0 | unsupported |
pip install mmpy_bot
First you need create the mattermost email/password for your bot.
For use all API(V4.0.0), you need add bot user to system admin group to avoid 403 error.
Then you need to configure the
BOT_URL,
BOT_LOGIN,
BOT_PASSWORD,
BOT_TEAMin a python module
mmpy_bot_settings.py, which must be located in a python import path.
mmpybotsettings.py:
SSL_VERIFY = True # Whether to perform SSL cert verification BOT_URL = 'http:///api/v4' # with 'http://' and with '/api/v4' path. without trailing slash. BOT_LOGIN = '' BOT_PASSWORD = '' BOT_TOKEN = None # or '' if you have set bot personal access token. BOT_TEAM = '' # possible in lowercase WEBHOOK_ID = '' # otherwise the bot will attempt to create one
Alternatively, you can use the environment variable
MATTERMOST_BOT_URL,
MATTERMOST_BOT_LOGIN,
MATTERMOST_BOT_PASSWORD,
MATTERMOST_BOT_TEAM,
MATTERMOST_BOT_SSL_VERIFY,
MATTERMOST_BOT_TOKEN
or
MATTERMOST_BOT_SETTINGS_MODULEenvironment variable, which provide settings module
MATTERMOST_BOT_SETTINGS_MODULE=settings.bot_conf mmpy_bot
Use the built-in cli script and point to your custom settings file.
MATTERMOST_BOT_SETTINGS_MODULE=mmpy_bot_settings mmpy_bot
or you can create your own startup file. For example
run.py:
from mmpy_bot.bot import Botif name == "main": Bot().run()
Now you can talk to your bot in your mattermost client!
from mmpy_bot.bot import respond_to@respond_to('webapi') def webapi_reply(message): attachments = [{ 'fallback': 'Fallback text', 'author_name': 'Author', 'author_link': 'http://www.github.com', 'text': 'Some text here ...', 'color': '#59afe1' }] message.reply_webapi( 'Attachments example', attachments, username='Mattermost-Bot', icon_url='https://goo.gl/OF4DBq', ) # Optional: Send message to specified channel # message.send_webapi('', attachments, channel_id=message.channel)
Integrations must be allowed for non admins users.
from mmpy_bot.bot import respond_to@respond_to('files') def message_with_file(message): # upload_file() can upload only one file at a time # If you have several files to upload, you need call this function several times. file = open('test.txt') result = message.upload_file(file) file.close() if 'file_infos' not in result: message.reply('upload file error') file_id = result['file_infos'][0]['id'] # file_id need convert to array message.reply('hello', [file_id])
A chat bot is meaningless unless you can extend/customize it to fit your own use cases.
To write a new plugin, simply create a function decorated by
mmpy_bot.bot.respond_toor
mmpy_bot.bot.listen_to:
respond_tois called when a message matching the pattern is sent to the bot (direct message or @botname in a channel/group chat)
listen_tois called when a message matching the pattern is sent on a channel/group chat (not directly sent to the bot)
import refrom mmpy_bot.bot import listen_to from mmpy_bot.bot import respond_to
@respond_to('hi', re.IGNORECASE) def hi(message): message.reply('I can understand hi or HI!')
@respond_to('I love you') def love(message): message.reply('I love you too!')
@listen_to('Can someone help me?') def help_me(message): # Message is replied to the sender (prefixed with @user) message.reply('Yes, I can!')
# Message is sent on the channel # message.send('I can help everybody!')
To extract params from the message, you can use regular expression: ```python from mmpybot.bot import respondto
@respondto('Give me (.*)') def giveme(message, something): message.reply('Here is %s' % something) ```
If you would like to have a command like 'stats' and 'stats startdate enddate', you can create reg ex like so:
from mmpy_bot.bot import respond_to import re@respond_to('stat$', re.IGNORECASE) @respond_to('stat (.) (.)', re.IGNORECASE) def stats(message, start_date=None, end_date=None): pass
If you don't want to expose some bot commands to public, you can add
@allowed_users()or
@allowed_channels()like so:
@respond_to('^admin$') @allow_only_direct_message() #only trigger by direct message, remove this line if you want call this in channel @allowed_users('Your username or email address here','[email protected]') # List of usernames or e-mails allowed @allowed_channels('allowed_channel_1','allowed_channel_2') # List of allowed channels def users_access(message): pass
Keep in mind the order matters!
@respond_to()and
@listen_to()must come before the "allowed" decorators.
And add the plugins module to
PLUGINSlist of mmpybot settings, e.g. mmpybot_settings.py:
PLUGINS = [ 'mmpy_bot.plugins', 'devops.plugins', # e.g. git submodule: domain:devops-plugins.git 'programmers.plugins', # e.g. python package: package_name.plugins 'frontend.plugins', # e.g. project tree: apps.bot.plugins ]
For example you can separate git repositories with plugins on your team.
If you are migrating from
Slackto the
Mattermost, and previously you are used
SlackBot, you can use this battery without any problem. On most cases your plugins will be working properly if you are used standard API or with minimal modifications.