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插件