{"id":26289966,"url":"https://github.com/slack-samples/bolt-python-starter-template","last_synced_at":"2025-04-09T21:21:53.926Z","repository":{"id":39616126,"uuid":"428473617","full_name":"slack-samples/bolt-python-starter-template","owner":"slack-samples","description":"A template for building Slack apps with Bolt for Python","archived":false,"fork":false,"pushed_at":"2025-04-01T17:50:41.000Z","size":92,"stargazers_count":63,"open_issues_count":4,"forks_count":19,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-04-02T19:08:11.910Z","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}},"created_at":"2021-11-16T01:12:20.000Z","updated_at":"2025-02-17T11:54:39.000Z","dependencies_parsed_at":"2023-02-14T04:46:13.899Z","dependency_job_id":"725bf560-9c7f-4a8a-a531-2f44c4b185ff","html_url":"https://github.com/slack-samples/bolt-python-starter-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-python-starter-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-python-starter-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-python-starter-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fbolt-python-starter-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-starter-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248112567,"owners_count":21049673,"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:30.781Z","updated_at":"2025-04-09T21:21:53.907Z","avatar_url":"https://github.com/slack-samples.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bolt for Python Template App\n\nThis is a generic Bolt for Python template app used to build out Slack apps.\n\nBefore getting started, make sure you have a development workspace where you have permissions to install apps. If you don’t have one setup, go ahead and [create one](https://slack.com/create).\n## Installation\n\n#### Create a Slack App\n1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and 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 says `*Paste your manifest code here*` (within the JSON tab) and click *Next*\n4. Review the configuration and click *Create*\n5. Click *Install to Workspace* and *Allow* on the screen that follows. You'll then be redirected to the App Configuration dashboard.\n\n#### Environment Variables\nBefore you can run the app, you'll need to store some environment variables.\n\n1. Open your apps configuration page from this list, click **OAuth \u0026 Permissions** in the left hand menu, then copy the Bot User OAuth Token. You will store this in your environment as `SLACK_BOT_TOKEN`.\n2. Click ***Basic Information** from the left hand menu and follow the steps in the App-Level Tokens section to create an app-level token with the `connections:write` scope. Copy this token. You will store this in your 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### Setup Your Local Project\n```zsh\n# Clone this project onto your machine\ngit clone https://github.com/slack-samples/bolt-python-starter-template.git\n\n# Change into this project directory\ncd bolt-python-starter-template\n\n# Setup your python virtual environment\npython3 -m venv .venv\nsource .venv/bin/activate\n\n# Install the dependencies\npip install -r requirements.txt\n\n# Start your local server\npython3 app.py\n```\n\n#### Linting\n```zsh\n# Run flake8 from root directory for linting\nflake8 *.py \u0026\u0026 flake8 listeners/\n\n# Run black from root directory for code formatting\nblack .\n```\n\n#### Testing\n```zsh\n# Run pytest from root directory for unit testing\npytest .\n```\n\n## Project Structure\n\n### `manifest.json`\n\n`manifest.json` is a configuration for Slack apps. With a manifest, you can create an app with a pre-defined configuration, or adjust the configuration of an existing app.\n\n### `app.py`\n\n`app.py` is the entry point for the application and is the file you'll run to start the server. This project aims to keep this file as thin as possible, primarily using it as a way to route inbound requests.\n\n### `/listeners`\n\nEvery incoming request is routed to a \"listener\". Inside this directory, we group each listener based on the Slack Platform feature used, so `/listeners/shortcuts` handles incoming [Shortcuts](https://api.slack.com/interactivity/shortcuts) requests, `/listeners/views` handles [View submissions](https://api.slack.com/reference/interaction-payloads/views#view_submission) and so on.\n\n## App Distribution / OAuth\n\nOnly implement OAuth if you plan to distribute your application across multiple workspaces. A separate `app_oauth.py` file can be found with relevant OAuth settings.\n\nWhen using OAuth, Slack requires a public URL where it can send requests. In this template app, we've used [`ngrok`](https://ngrok.com/download). Checkout [this guide](https://ngrok.com/docs#getting-started-expose) for setting it up.\n\nStart `ngrok` to access the app on an external network and create a redirect URL for OAuth. \n\n```\nngrok http 3000\n```\n\nThis output should include a forwarding address for `http` and `https` (we'll use `https`). It should look something like the following:\n\n```\nForwarding   https://3cb89939.ngrok.io -\u003e http://localhost:3000\n```\n\nNavigate to **OAuth \u0026 Permissions** in your app configuration and click **Add a Redirect URL**. The redirect URL should be set to your `ngrok` forwarding address with the `slack/oauth_redirect` path appended. For example:\n\n```\nhttps://3cb89939.ngrok.io/slack/oauth_redirect\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fbolt-python-starter-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslack-samples%2Fbolt-python-starter-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fbolt-python-starter-template/lists"}