使用 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 代碼：

from mattermostdriver import Driver

bot_username = 'bot_username'
bot_password = 'bot_password'
server_url = 'https://your.mattermost.server.url'

def main():
    driver = Driver({'url': server_url, 'login_id': bot_username, 'password': bot_password, 'scheme': 'https'})
    driver.login()
    team = driver.teams.get_team_by_name('team_name')
    channel = driver.channels.get_channel_by_name(team['id'], 'channel_name')

    @driver.on('message')
    def handle_message(post, **kwargs):
        if post['message'] == 'hello':
            driver.posts.create_post({
                'channel_id': post['channel_id'],
                'message': 'Hi there!'
            })

    driver.init_websocket()

if __name__ == '__main__':
    main()

添加功能

在 Mattermost 上創建基本的 ChatOps 機器人後，你可以添加更多功能來擴展其功能。以下是步驟：

• 確定要添加的功能：在編寫代碼之前，你必須確定要添加到 ChatOps 機器人的功能。可以是從發送通知到與第三方工具集成的任何事情。
• 編寫代碼：確定要添加的功能後，就可以開始編寫代碼了。代碼將取決於添加的功能，但你可以使用 Mattermost Python 驅動與 Mattermost API 交互並實現該功能。
• 測試代碼：編寫代碼後，重要的是對其進行測試以確保其按預期工作。在將其部署到生產伺服器之前，你可以在開發伺服器或測試通道中測試代碼。
• 部署代碼：當你對其進行了測試並且它按預期工作，你就可以將其部署到你的生產伺服器。遵循你組織的部署流程並確保新代碼不會破壞任何現有功能。
• 記錄新功能：記錄你添加到 ChatOps 機器人的新功能非常重要。這將使其他團隊成員更容易使用該機器人並了解其功能。

一個 ChatOps Bot 功能示例是與第三方工具集成並提供某些任務的狀態更新。

from mattermostdriver import Driver
import requests

bot_username = 'bot_username'
bot_password = 'bot_password'
server_url = 'https://your.mattermost.server.url'

def main():
    driver = Driver({'url': server_url, 'login_id': bot_username, 'password': bot_password, 'scheme': 'https'})
    driver.login()
    team = driver.teams.get_team_by_name('team_name')
    channel = driver.channels.get_channel_by_name(team['id'], 'channel_name')

    @driver.on('message')
    def handle_message(post, **kwargs):
        if post['message'] == 'status':
            # Make a request to the third-party tool API to get the status
            response = requests.get('https://api.thirdpartytool.com/status')
            if response.status_code == 200:
                status = response.json()['status']
                driver.posts.create_post({
                    'channel_id': post['channel_id'],
                    'message': f'The status is {status}'
                })
            else:
                driver.posts.create_post({
                    'channel_id': post['channel_id'],
                    'message': 'Failed to get status'
                })

    driver.init_websocket()

if __name__ == '__main__':
    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中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive