bolt-python

环境要求

• Python 3.7 或更高版本
• 可用的终端/命令行环境
• 已安装的 Slack 应用（需获取 Signing Secret 与 xoxb- Bot Token）
• （Socket Mode 方式）Slack 应用已启用 Socket Mode

安装与启动步骤

1. 1检查 Python 版本

   README 要求 Python 3.7+，先确认本机版本满足要求，否则后续安装会失败。

   python --version

   复制

2. 2创建并激活虚拟环境

   在项目目录下创建 .venv 虚拟环境并激活，避免污染系统 Python 环境。

   python -m venv .venv
   source .venv/bin/activate

   复制

3. 3安装 Slack Bolt

   先升级 pip，再安装 PyPI 上的 slack_bolt 包（PyPI 项目名为 slack-bolt）。

   pip install -U pip
   pip install slack_bolt

   复制

4. 4配置环境变量

   把 Slack 应用后台的 Signing Secret 和 Bot Token 导出为环境变量，供 App() 读取。

   export SLACK_SIGNING_SECRET=your-signing-secret
   export SLACK_BOT_TOKEN=xoxb-xxxxxxxxxxxx

   复制

5. 5编写 app.py

   调用顶层导出的 App() 构造应用，并加自己的事件/命令逻辑；不改动时即为最小可运行示例。

   import logging
   logging.basicConfig(level=logging.DEBUG)
   
   from slack_bolt import App
   
   # export SLACK_SIGNING_SECRET=***
   # export SLACK_BOT_TOKEN=xoxb-***
   app = App()
   
   # Add functionality here
   
   if __name__ == "__main__":
       app.start(3000)  # POST http://localhost:3000/slack/events

   复制

6. 6运行应用

   启动后应用监听 3000 端口，Slack 请求地址为 /slack/events，需要公网可访问。

   python app.py

   复制

7. 7改用 Socket Mode

   不想暴露公网地址时，用 SocketModeHandler 运行，README 明确说明此方式不需要 ngrok。

   import os
   from slack_bolt import App
   from slack_bolt.adapter.socket_mode import SocketModeHandler
   
   # Install the Slack app and get xoxb- token in advance
   app = App(token=os.environ["SLACK_BOT_TOKEN"])
   
   # Running ngrok is not required

   复制

关键配置

如何确认成功

终端无异常报错，应用成功启动并监听 3000 端口，请求路径为 POST http://localhost:3000/slack/events。

常见问题

注意事项

• 不要将真实 Signing Secret 或 Token 写入代码或提交到仓库，README 示例用环境变量传递。
• app.start(3000) 监听的是本地 3000 端口，部署到线上时需保证 Slack 能访问 /slack/events。
• 此公开仓库地址为 https://github.com/slackapi/bolt-python，更多用法见 getting started 指南与 examples 目录。