{"id":26289962,"url":"https://github.com/slack-samples/bolt-python-custom-step-template","last_synced_at":"2025-05-07T22:43:50.301Z","repository":{"id":221020268,"uuid":"740618715","full_name":"slack-samples/bolt-python-custom-step-template","owner":"slack-samples","description":"A template for building automations with Bolt for Python","archived":false,"fork":false,"pushed_at":"2025-05-01T19:39:21.000Z","size":49,"stargazers_count":14,"open_issues_count":1,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-01T20:33:34.708Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/slack-samples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-01-08T18:00:26.000Z","updated_at":"2025-05-01T19:39:24.000Z","dependencies_parsed_at":"2024-03-20T23:29:11.488Z","dependency_job_id":"1a0bf348-8f5a-4799-8e6a-3fafc7e587e9","html_url":"https://github.com/slack-samples/bolt-python-custom-step-template","commit_stats":null,"previous_names":["slack-samples/bolt-python-custom-function-template"],"tags_count":0,"template":true,"template_full_name":"slack-samples/bolt-python-starter-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-python-custom-step-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-python-custom-step-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-python-custom-step-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-python-custom-step-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slack-samples","download_url":"https://codeload.github.com/slack-samples/bolt-python-custom-step-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252967973,"owners_count":21833245,"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":[],"created_at":"2025-03-14T23:17:29.564Z","updated_at":"2025-05-07T22:43:50.281Z","avatar_url":"https://github.com/slack-samples.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bolt for Python Custom Step Template\n\nThis is a Bolt for Python template app used to build custom steps for use in\n[Workflow Builder](https://api.slack.com/start#workflow-builder).\n\n## Setup\n\nBefore getting started, first make sure you have a development workspace where\nyou have permission to install apps. **Please note that the features in this\nproject require that the workspace be part of\n[a Slack paid plan](https://slack.com/pricing).**\n\n### Developer Program\n\nJoin the [Slack Developer Program](https://api.slack.com/developer-program) for\nexclusive access to sandbox environments for building and testing your apps,\ntooling, and resources created to help developers build and grow.\n\n## Installation\n\n### Create a Slack App\n\n1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and\n   choose \"From an app manifest\"\n2. Choose the workspace you want to install the application to\n3. Copy the contents of [manifest.json](./manifest.json) into the text box that\n   says `*Paste your manifest code here*` (within the JSON tab) and click _Next_\n4. Review the configuration and click _Create_\n5. Click _Install_ button and _Allow_ on the screen that follows. You'll then be\n   redirected to the App Settings dashboard.\n\n### Environment Variables\n\nBefore you can run the app, you'll need to store some environment variables.\n\n1. Open your apps setting page from this list, click **OAuth \u0026 Permissions** in\n   the left hand menu, then copy the Bot User OAuth Token. You will store this\n   in your environment as `SLACK_BOT_TOKEN`.\n2. Click **Basic Information** from the left hand menu and follow the steps in\n   the App-Level Tokens section to create an app-level token with the\n   `connections:write` scope. Copy this token. You will store this in your\n   environment as `SLACK_APP_TOKEN`.\n\n```zsh\n# Replace with your app token and bot token\nexport SLACK_BOT_TOKEN=\u003cyour-bot-token\u003e\nexport SLACK_APP_TOKEN=\u003cyour-app-token\u003e\n```\n\n### Local Project\n\n```zsh\n# Clone this project onto your machine\ngit clone https://github.com/slack-samples/bolt-python-custom-step-template.git\n\n# Change into this project directory\ncd bolt-python-custom-step-template\n\n# Setup your python virtual environment\npython3 -m venv .venv\nsource .venv/bin/activate\n\n# Install the dependencies\npip3 install -r requirements.txt\n\n# Start your local server\npython3 app.py\n```\n\n### Linting\n\nRun flake8 and black for linting and code formatting:\n\n```zsh\n# Run ruff from root directory for linting\nruff check\n\n# Run ruff from root directory for code formatting\nruff format\nruff check --fix\n```\n\n## Using Steps in Workflow Builder\n\nWith your server running, the `Sample step` is now ready for use in\n[Workflow Builder](https://api.slack.com/start#workflow-builder)! Add it as a\ncustom step in a new or existing workflow, then run the workflow while your app\nis running.\n\nFor more information on creating workflows and adding custom steps, read more\n[here](https://slack.com/help/articles/17542172840595-Create-a-new-workflow-in-Slack).\n\n## Project Structure\n\n### `app.py`\n\n`app.py` is the entry point for the application and is the file you'll run to\nstart the server. This project aims to keep this file as thin as possible,\nprimarily using it as a way to route inbound requests.\n\n### `manifest.json`\n\n`manifest.json` is a configuration for Slack apps. With a manifest, you can\ncreate an app with a pre-defined configuration, or adjust the configuration of\nan existing app.\n\n### `/listeners`\n\nEvery incoming request is routed to a \"listener\". Inside this directory, we\ngroup each listener based on the Slack Platform feature used, so\n`/listeners/actions.py` handles incoming\n[Actions](https://api.slack.com/reference/interaction-payloads/block-actions)\nrequests, `/listeners/functions.py` handles\n[Custom Steps](https://api.slack.com/automation/functions/custom-bolt) and so\non.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fbolt-python-custom-step-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslack-samples%2Fbolt-python-custom-step-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fbolt-python-custom-step-template/lists"}