Документация доступна на странице «Прочитайте документы».
Платформа чат-ботов на основе Python для Mattermost. Код этой платформы ботов был сильно переработан в версии 2.0.0 и будет работать только с Python 3.8 или выше. Для поддержки Python 2 и Python3 < 3.8 используйте версии v1.3.9 или ниже.
самое важное | mmpy_bot |
---|---|
>= 4,0 | > 1.2.0 |
< 4,0 | неподдерживаемый |
pip install mmpy-bot
pip install mmpy-bot==1.3.9
Сначала вам нужно создать учетную запись бота на вашем сервере Mattermost. Примечание. Включить создание учетной записи бота необходимо включить в системной консоли.
Обратите внимание, что некоторые функции API, такие как ответы на временные сообщения, потребуют, чтобы бот был частью группы системных администраторов , однако большинство функций API будут работать с ролью обычной учетной записи участника . Просто имейте в виду, что если некоторые функции API не работают, это может быть связано с отсутствием соответствующих разрешений.
Создайте файл точки входа (или скопируйте предоставленный), который определяет настройки вашего сервера Mattermost и учетной записи бота, а также импортирует нужные модули.
Пример 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 ()
Установите бит исполняемого файла в файле точки входа (т. е. chmod +x my_bot.py
) и запустите бота из командной строки. Теперь вы можете общаться со своим ботом в клиенте Mattermost!
Чтобы получить максимальную отдачу от вашего бота, вам нужно будет написать свои собственные плагины. Чтобы начать, обратитесь к документации по плагинам.
Основным каналом связи является GitHub через Issues или Pull Requests, но вы также можете найти некоторых из нас в Discord для взаимодействия в реальном времени.