{"id":13624172,"url":"https://github.com/slackapi/bolt-python","last_synced_at":"2025-05-13T00:19:43.946Z","repository":{"id":38536304,"uuid":"268795735","full_name":"slackapi/bolt-python","owner":"slackapi","description":"A framework to build Slack apps using Python","archived":false,"fork":false,"pushed_at":"2025-04-30T15:25:35.000Z","size":10560,"stargazers_count":1171,"open_issues_count":26,"forks_count":264,"subscribers_count":33,"default_branch":"main","last_synced_at":"2025-05-08T00:02:02.602Z","etag":null,"topics":["aiohttp","aiohttp-client","asyncio","bolt","chatbot","chatops","django","docker","fastapi","flask","pypi-url","python","slack","slack-api","socket-mode","web-api","websocket","websocket-client","websockets"],"latest_commit_sha":null,"homepage":"https://tools.slack.dev/bolt-python/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slackapi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-06-02T12:32:17.000Z","updated_at":"2025-05-07T19:58:10.000Z","dependencies_parsed_at":"2023-11-18T00:59:07.929Z","dependency_job_id":"25c33b0c-5d05-4642-8510-a29066d6df53","html_url":"https://github.com/slackapi/bolt-python","commit_stats":{"total_commits":750,"total_committers":55,"mean_commits":"13.636363636363637","dds":0.4013333333333333,"last_synced_commit":"e322a288fa3228503dae7355f59ad4fcf4eedb63"},"previous_names":[],"tags_count":119,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slackapi%2Fbolt-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slackapi%2Fbolt-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slackapi%2Fbolt-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slackapi%2Fbolt-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slackapi","download_url":"https://codeload.github.com/slackapi/bolt-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252973673,"owners_count":21834108,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aiohttp","aiohttp-client","asyncio","bolt","chatbot","chatops","django","docker","fastapi","flask","pypi-url","python","slack","slack-api","socket-mode","web-api","websocket","websocket-client","websockets"],"created_at":"2024-08-01T21:01:39.740Z","updated_at":"2025-05-13T00:19:43.923Z","avatar_url":"https://github.com/slackapi.png","language":"Python","readme":"\u003ch1 align=\"center\"\u003eBolt \u003cimg src=\"https://raw.githubusercontent.com/slackapi/bolt-python/main/docs/static/img/bolt-logo.svg\" alt=\"Bolt logo\" width=\"32\"/\u003e for Python\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://pypi.org/project/slack-bolt/\"\u003e\n        \u003cimg alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/slack-bolt\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://codecov.io/gh/slackapi/bolt-python\"\u003e\n        \u003cimg alt=\"Codecov\" src=\"https://img.shields.io/codecov/c/gh/slackapi/bolt-python\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pepy.tech/project/slack-bolt\"\u003e\n        \u003cimg alt=\"Pepy Total Downloads\" src=\"https://img.shields.io/pepy/dt/slack-bolt\"\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://pypi.org/project/slack-bolt/\"\u003e\n        \u003cimg alt=\"Python Versions\" src=\"https://img.shields.io/pypi/pyversions/slack-bolt.svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://tools.slack.dev/bolt-python/\"\u003e\n        \u003cimg alt=\"Documentation\" src=\"https://img.shields.io/badge/dev-docs-yellow\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nA Python framework to build Slack apps in a flash with the latest platform features. Read the [getting started guide](https://tools.slack.dev/bolt-python/getting-started) and look at our [code examples](https://github.com/slackapi/bolt-python/tree/main/examples) to learn how to build apps using Bolt. The Python module documents are available [here](https://tools.slack.dev/bolt-python/api-docs/slack_bolt/).\n\n## Setup\n\n```bash\n# Python 3.6+ required\npython -m venv .venv\nsource .venv/bin/activate\n\npip install -U pip\npip install slack_bolt\n```\n\n## Creating an app\n\nCreate a Bolt for Python app by calling a constructor, which is a top-level export. If you'd prefer, you can create an [async app](#creating-an-async-app).\n\n```python\nimport logging\nlogging.basicConfig(level=logging.DEBUG)\n\nfrom slack_bolt import App\n\n# export SLACK_SIGNING_SECRET=***\n# export SLACK_BOT_TOKEN=xoxb-***\napp = App()\n\n# Add functionality here\n\nif __name__ == \"__main__\":\n    app.start(3000)  # POST http://localhost:3000/slack/events\n```\n\n## Running an app\n\n```bash\nexport SLACK_SIGNING_SECRET=***\nexport SLACK_BOT_TOKEN=xoxb-***\npython app.py\n\n# in another terminal\nngrok http 3000\n```\n\n## Running a Socket Mode app\n\nIf you use [Socket Mode](https://api.slack.com/socket-mode) for running your app, `SocketModeHandler` is available for it.\n\n```python\nimport os\nfrom slack_bolt import App\nfrom slack_bolt.adapter.socket_mode import SocketModeHandler\n\n# Install the Slack app and get xoxb- token in advance\napp = App(token=os.environ[\"SLACK_BOT_TOKEN\"])\n\n# Add functionality here\n\nif __name__ == \"__main__\":\n    # Create an app-level token with connections:write scope\n    handler = SocketModeHandler(app, os.environ[\"SLACK_APP_TOKEN\"])\n    handler.start()\n```\n\nRun the app this way:\n\n```bash\nexport SLACK_APP_TOKEN=xapp-***\nexport SLACK_BOT_TOKEN=xoxb-***\npython app.py\n\n# SLACK_SIGNING_SECRET is not required\n# Running ngrok is not required\n```\n\n## Listening for events\n\nApps typically react to a collection of incoming events, which can correspond to [Events API events](https://api.slack.com/events-api), [actions](https://api.slack.com/interactivity/components), [shortcuts](https://api.slack.com/interactivity/shortcuts), [slash commands](https://api.slack.com/interactivity/slash-commands) or [options requests](https://api.slack.com/reference/block-kit/block-elements#external_select). For each type of\nrequest, there's a method to build a listener function.\n\n```python\n# Listen for an action from a Block Kit element (buttons, select menus, date pickers, etc)\napp.action(action_id)(fn)\n\n# Listen for dialog submissions\napp.action({\"callback_id\": callbackId})(fn)\n\n# Listen for slash commands\napp.command(command_name)(fn)\n\n# Listen for an event from the Events API\napp.event(event_type)(fn)\n\n# Listen for a custom step execution from a workflow\napp.function(callback_id)(fn)\n\n# Convenience method to listen to only `message` events using a string or re.Pattern\napp.message([pattern ,])(fn)\n\n# Listen for options requests (from select menus with an external data source)\napp.options(action_id)(fn)\n\n# Listen for a global or message shortcuts\napp.shortcut(callback_id)(fn)\n\n# Listen for view_submission modal events\napp.view(callback_id)(fn)\n```\n\nThe recommended way to use these methods are decorators:\n\n```python\n@app.event(event_type)\ndef handle_event(event):\n    pass\n```\n\n## Making things happen\n\nMost of the app's functionality will be inside listener functions (the `fn` parameters above). These functions are called with a set of arguments, each of which can be used in any order. If you'd like to access arguments off of a single object, you can use `args`, an [`slack_bolt.kwargs_injection.Args`](https://github.com/slackapi/bolt-python/blob/main/slack_bolt/kwargs_injection/args.py) instance that contains all available arguments for that event.\n\n| Argument  | Description  |\n| :---: | :--- |\n| `body` | Dictionary that contains the entire body of the request (superset of `payload`). Some accessory data is only available outside of the payload (such as `trigger_id` and `authorizations`).\n| `payload` | Contents of the incoming event. The payload structure depends on the listener. For example, for an Events API event, `payload` will be the [event type structure](https://api.slack.com/events-api#event_type_structure). For a block action, it will be the action from within the `actions` list. The `payload` dictionary is also accessible via the alias corresponding to the listener (`message`, `event`, `action`, `shortcut`, `view`, `command`, or `options`). For example, if you were building a `message()` listener, you could use the `payload` and `message` arguments interchangably. **An easy way to understand what's in a payload is to log it**. |\n| `context` | Event context. This dictionary contains data about the event and app, such as the `botId`. Middleware can add additional context before the event is passed to listeners.\n| `ack` | Function that **must** be called to acknowledge that your app received the incoming event. `ack` exists for all actions, shortcuts, view submissions, slash command and options requests. `ack` returns a promise that resolves when complete. Read more in [Acknowledging events](https://tools.slack.dev/bolt-python/concepts/acknowledge).\n| `respond` | Utility function that responds to incoming events **if** it contains a `response_url` (shortcuts, actions, and slash commands).\n| `say` | Utility function to send a message to the channel associated with the incoming event. This argument is only available when the listener is triggered for events that contain a `channel_id` (the most common being `message` events). `say` accepts simple strings (for plain-text messages) and dictionaries (for messages containing blocks).\n| `client` | Web API client that uses the token associated with the event. For single-workspace installations, the token is provided to the constructor. For multi-workspace installations, the token is returned by using [the OAuth library](https://tools.slack.dev/bolt-python/concepts/authenticating-oauth), or manually using the `authorize` function.\n| `logger` | The built-in [`logging.Logger`](https://docs.python.org/3/library/logging.html) instance you can use in middleware/listeners.\n| `complete` | Utility function used to signal the successful completion of a custom step execution. This tells Slack to proceed with the next steps in the workflow. This argument is only available with the `.function` and `.action` listener when handling custom workflow step executions.\n| `fail` | Utility function used to signal that a custom step failed to complete. This tells Slack to stop the workflow execution. This argument is only available with the `.function` and `.action` listener when handling custom workflow step executions.\n\n## Creating an async app\n\nIf you'd prefer to build your app with [asyncio](https://docs.python.org/3/library/asyncio.html), you can import the [AIOHTTP](https://docs.aiohttp.org/en/stable/) library and call the `AsyncApp` constructor. Within async apps, you can use the async/await pattern.\n\n```bash\n# Python 3.6+ required\npython -m venv .venv\nsource .venv/bin/activate\n\npip install -U pip\n# aiohttp is required\npip install slack_bolt aiohttp\n```\n\nIn async apps, all middleware/listeners must be async functions. When calling utility methods (like `ack` and `say`) within these functions, it's required to use the `await` keyword.\n\n```python\n# Import the async app instead of the regular one\nfrom slack_bolt.async_app import AsyncApp\n\napp = AsyncApp()\n\n@app.event(\"app_mention\")\nasync def event_test(body, say, logger):\n    logger.info(body)\n    await say(\"What's up?\")\n\n@app.command(\"/hello-bolt-python\")\nasync def command(ack, body, respond):\n    await ack()\n    await respond(f\"Hi \u003c@{body['user_id']}\u003e!\")\n\nif __name__ == \"__main__\":\n    app.start(3000)\n```\n\nIf you want to use another async Web framework (e.g., Sanic, FastAPI, Starlette), take a look at the built-in adapters and their examples.\n\n* [The Bolt app examples](https://github.com/slackapi/bolt-python/tree/main/examples)\n* [The built-in adapters](https://github.com/slackapi/bolt-python/tree/main/slack_bolt/adapter)\nApps can be run the same way as the syncronous example above. If you'd prefer another async Web framework (e.g., Sanic, FastAPI, Starlette), take a look at [the built-in adapters](https://github.com/slackapi/bolt-python/tree/main/slack_bolt/adapter) and their corresponding [examples](https://github.com/slackapi/bolt-python/tree/main/examples).\n\n## Getting Help\n\n[The documentation](https://tools.slack.dev/bolt-python) has more information on basic and advanced concepts for Bolt for Python. Also, all the Python module documents of this library are available [here](https://tools.slack.dev/bolt-python/api-docs/slack_bolt/).\n\nIf you otherwise get stuck, we're here to help. The following are the best ways to get assistance working through your issue:\n\n  * [Issue Tracker](http://github.com/slackapi/bolt-python/issues) for questions, bug reports, feature requests, and general discussion related to Bolt for Python. Try searching for an existing issue before creating a new one.\n  * [Email](mailto:support@slack.com) our developer support team: `support@slack.com`\n\n\n[pypi-image]: https://badge.fury.io/py/slack-bolt.svg\n[pypi-url]: https://pypi.org/project/slack-bolt/\n[codecov-image]: https://codecov.io/gh/slackapi/bolt-python/branch/main/graph/badge.svg\n[codecov-url]: https://codecov.io/gh/slackapi/bolt-python\n[python-version]: https://img.shields.io/pypi/pyversions/slack-bolt.svg\n","funding_links":[],"categories":["Python",":hammer_and_wrench: \u0026nbsp; Libraries and SDKs"],"sub_categories":["Python"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslackapi%2Fbolt-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslackapi%2Fbolt-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslackapi%2Fbolt-python/lists"}