使用 Python 在 Mattermost 中创建 ChatOps 聊天机器人

用一个简单的开源机器人在你的组织中实施 ChatOps。

ChatOps 是一种协作模型，它将人员、流程、工具和自动化连接到一个透明的工作流中。Mattermost 是一个开源、自托管的消息平台，使组织能够安全、有效和高效地进行通信。它是 Slack、Discord 和其他专有消息平台的绝佳 开源替代品。本文概述了在 Mattermost 上创建 ChatOps 机器人的步骤，包括必要的代码示例和解释。

先决条件

在开始之前，请确保你可以访问 Mattermost 服务器，安装 Python，并 使用 pip 安装 Mattermost Python 驱动。

在 Mattermost 上创建一个机器人帐户

要创建机器人帐户，请访问 Mattermost 系统控制台，并添加具有适当访问权限的机器人帐户。获取机器人的用户名和密码以在 Python 脚本中使用。

设置 Mattermost Python 驱动

使用 pip 安装 Mattermost Python 驱动，并将其导入 Python 脚本。创建一个新的驱动实例并登录到 Mattermost 服务器。

在 Python 中创建 ChatOps 机器人

创建一个新的 Python 脚本，定义要导入的必要库，并使用 Mattermost 驱动的 API 实现机器人的功能。编写代码来处理消息、命令和其他事件，并使用 Mattermost 驱动的 API 方法向通道和用户发送消息和通知。最后，调试和测试 ChatOps 机器人。

ChatOps 机器人代码示例

以下是响应用户消息的简单 ChatOps 机器人的示例 Python 代码：

1. from mattermostdriver import Driver
3. bot_username = 'bot_username'
4. bot_password = 'bot_password'
5. server_url = 'https://your.mattermost.server.url'
7. def main():
8. driver = Driver({'url': server_url, 'login_id': bot_username, 'password': bot_password, 'scheme': 'https'})
9. driver.login()
10. team = driver.teams.get_team_by_name('team_name')
11. channel = driver.channels.get_channel_by_name(team['id'], 'channel_name')
13. @driver.on('message')
14. def handle_message(post, **kwargs):
15. if post['message'] == 'hello':
16. driver.posts.create_post({
17. 'channel_id': post['channel_id'],
18. 'message': 'Hi there!'
19. })
21. driver.init_websocket()
23. if __name__ == '__main__':
24. main()

添加功能

在 Mattermost 上创建基本的 ChatOps 机器人后，你可以添加更多功能来扩展其功能。以下是步骤：

• 确定要添加的功能：在编写代码之前，你必须确定要添加到 ChatOps 机器人的功能。可以是从发送通知到与第三方工具集成的任何事情。
• 编写代码：确定要添加的功能后，就可以开始编写代码了。代码将取决于添加的功能，但你可以使用 Mattermost Python 驱动与 Mattermost API 交互并实现该功能。
• 测试代码：编写代码后，重要的是对其进行测试以确保其按预期工作。在将其部署到生产服务器之前，你可以在开发服务器或测试通道中测试代码。
• 部署代码：当你对其进行了测试并且它按预期工作，你就可以将其部署到你的生产服务器。遵循你组织的部署流程并确保新代码不会破坏任何现有功能。
• 记录新功能：记录你添加到 ChatOps 机器人的新功能非常重要。这将使其他团队成员更容易使用该机器人并了解其功能。

一个 ChatOps Bot 功能示例是与第三方工具集成并提供某些任务的状态更新。

1. from mattermostdriver import Driver
2. import requests
4. bot_username = 'bot_username'
5. bot_password = 'bot_password'
6. server_url = 'https://your.mattermost.server.url'
8. def main():
9. driver = Driver({'url': server_url, 'login_id': bot_username, 'password': bot_password, 'scheme': 'https'})
10. driver.login()
11. team = driver.teams.get_team_by_name('team_name')
12. channel = driver.channels.get_channel_by_name(team['id'], 'channel_name')
14. @driver.on('message')
15. def handle_message(post, **kwargs):
16. if post['message'] == 'status':
17. # Make a request to the third-party tool API to get the status
18. response = requests.get('https://api.thirdpartytool.com/status')
19. if response.status_code == 200:
20. status = response.json()['status']
21. driver.posts.create_post({
22. 'channel_id': post['channel_id'],
23. 'message': f'The status is {status}'
24. })
25. else:
26. driver.posts.create_post({
27. 'channel_id': post['channel_id'],
28. 'message': 'Failed to get status'
29. })
31. driver.init_websocket()
33. if __name__ == '__main__':
34. main()

在此示例中，ChatOps 机器人监听命令 status 并向第三方工具 API 发出请求以获取当前状态。然后它会在发出命令的 Mattermost 频道中发布状态更新。这使团队成员无需离开聊天平台即可快速获取任务状态的更新。

开源 ChatOps

总之，在 Mattermost 上创建 ChatOps 机器人是一个简单的过程，可以为你组织的沟通和工作流程带来许多好处。本文提供了分步分解和代码示例，可帮助你开始创建你的机器人，甚至可以通过添加新功能对其进行自定义。现在你了解了基础知识，你可以进一步探索 ChatOps 和 Mattermost 以优化团队的协作和生产力。

via: https://opensource.com/article/23/3/chatbot-mattermost-python

作者：Dr. Michael J. Garbade 选题：lkxed 译者：geekpi 校对：wxy

本文由 LCTT 原创编译，Linux中国 荣誉推出

转自 技术|使用 Python 在 Mattermost 中创建 ChatOps 聊天机器人 (linux.cn)