slack machine

鬆弛的機器

Slack Machine是一個簡單但功能強大且可擴展的Slack Bot框架。 Slack Machine不僅是機器人，還可以幫助您將Slack Workspace開發到ChatOps Powerhouse中。 Slack Machine是使用直觀插件系統構建的，該系統使您可以快速構建機器人，但也可以簡單地進行代碼組織。插件看起來很簡單：

 from machine . plugins . base import MachineBasePlugin
from machine . plugins . message import Message
from machine . plugins . decorators import respond_to


class DeploymentPlugin ( MachineBasePlugin ):
    """Deployments"""

    @ respond_to ( r"deploy (?P<application>w+) to (?P<environment>w+)" )
    async def deploy ( self , msg : Message , application , environment ):
        """deploy <application> <environment>: deploy application to target environment"""
        await msg . say ( f"Deploying { application } to { environment } " )

打破變化

對Python 3.8（V0.38.0）的支持下降了

截至v0.38.0，對Python 3.8的支持已被刪除。 Python 3.8已於2024-10-07達到壽命。

特徵

• 開始使用淡構型
• 建立在Slack Events API之上，以便在半實時響應事件。使用套接字模式，因此您的機器人不需要接觸到Internet！
• 使用Slack Web API支持豐富的互動
• 高級API可在構建插件時最大程度的便利
• 低水平API可獲得最大的靈活性
• 建立在Asyncio之上，以通過同時處理Slack的溝通來確保良好的性能

插件API功能：

• 聽並回應任何正則表達
• 響應斜線命令
• 捕獲一部分消息，以用作變量的功能
• 響應頻道，組和直接消息對話中的消息
• 作出反應
• 響應線程
• 響應短暫的消息
• 將DMS發送給任何用戶
• 支持塊
• 支持消息附件[遺產？]
• 支持交互元素
• 支持模態
• 聆聽並回應事件API支持的任何鬆弛事件
• 在持久存儲中存儲並檢索任何類型的數據（當前支持Redis，DynamoDB，Sqlite和內存存儲）
• 安排操作和消息
• 散發和聽事件
• 幫助插件的文本

即將推出

• 支持快捷方式
• ...還有更多

安裝

您可以通過運行：

uv add slack-machine

或將其添加到您的詩歌項目中：

poetry add slack-machine

最後，您可以使用PIP安裝它（不建議）：

$ pip install slack-machine

強烈建議您在虛擬環境中安裝slack-machine ！

用法

1. 為您的Slack Machine Bot創建一個目錄： mkdir my-slack-bot && cd my-slack-bot

2. 將local_settings.py文件添加到您的bot目錄： touch local_settings.py

3. 在Slack：https：//api.slack.com/apps中創建一個新應用

4. 選擇從應用清單創建應用程序

5. 複製/粘貼以下清單： manifest.yaml

6. 將Slack App和Bot令牌添加到您的local_settings.py之類的：

    SLACK_APP_TOKEN = "xapp-my-app-token"
   SLACK_BOT_TOKEN = "xoxb-my-bot-token"
   

7. 使用slack-machine啟動機器人

8. ...

9. 利潤！

文件

您可以在此處找到Slack Machine的文檔：https：//dondebonair.github.io/slack-machine/

去閱讀它以了解如何正確配置Slack Machine，編寫插件等等！

還有一個示例插件，顯示了Slack Machine的許多功能：Slack Machine KitchenSink插件