Initial commit

Author: seratch

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 125
+exclude = .gitignore,venv

.github/CODEOWNERS

@@ -0,0 +1,6 @@
+# Code owners are the default owners for everything in
+# this repository. The owners listed below will be requested for
+# review when a pull request is opened.
+# To add code owner(s), uncomment the line below and
+# replace the @global-owner users with their GitHub username(s).
+# *       @global-owner1 @global-owner2

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    labels:
+      - "pip"
+      - "dependencies"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/black.yml

@@ -0,0 +1,29 @@
+name: Formatting validation using black
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      matrix:
+        python-version: ['3.9']
+    
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install -U pip
+        pip install -r requirements.txt
+    - name: Format with black
+      run: |
+        black .
+        if git status --porcelain | grep .; then git --no-pager diff; exit 1; fi

.github/workflows/flake8.yml

@@ -0,0 +1,28 @@
+name: Linting validation using flake8
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      matrix:
+        python-version: ['3.9']
+    
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install -U pip
+        pip install -r requirements.txt
+    - name: Lint with flake8
+      run: |
+        flake8 *.py && flake8 listeners/

.gitignore

@@ -0,0 +1,38 @@
+# general things to ignore
+build/
+dist/
+docs/_sources/
+docs/.doctrees
+.eggs/
+*.egg-info/
+*.egg
+*.py[cod]
+__pycache__/
+*.so
+*~
+
+# virtualenv
+env*/
+venv/
+.venv*
+.env*
+
+# codecov / coverage
+.coverage
+cov_*
+coverage.xml
+
+# due to using tox and pytest
+.tox
+.cache
+.pytest_cache/
+.python-version
+pip
+.mypy_cache/
+
+# misc
+tmp.txt
+.DS_Store
+logs/
+*.db
+.pytype/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Slack Technologies, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,91 @@
+# Bolt for Python Template App
+
+This is a generic Bolt for Python template app used to build out Slack apps.
+
+Before 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).
+## Installation
+
+#### Create a Slack App
+1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and choose "From an app manifest"
+2. Choose the workspace you want to install the application to
+3. 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*
+4. Review the configuration and click *Create*
+5. Click *Install to Workspace* and *Allow* on the screen that follows. You'll then be redirected to the App Configuration dashboard.
+
+#### Environment Variables
+Before you can run the app, you'll need to store some environment variables.
+
+1. Open your apps configuration page from this list, click **OAuth & Permissions** in the left hand menu, then copy the Bot User OAuth Token. You will store this in your environment as `SLACK_BOT_TOKEN`.
+2. 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`.
+
+```zsh
+# Replace with your app token and bot token
+export SLACK_BOT_TOKEN=<your-bot-token>
+export SLACK_APP_TOKEN=<your-app-token>
+```
+
+### Setup Your Local Project
+```zsh
+# Clone this project onto your machine
+git clone https://github.com/slack-samples/bolt-python-starter-template.git
+
+# Change into this project directory
+cd bolt-python-starter-template
+
+# Setup your python virtual environment
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Install the dependencies
+pip install -r requirements.txt
+
+# Start your local server
+python3 app.py
+```
+
+#### Linting
+```zsh
+# Run flake8 from root directory for linting
+flake8 *.py && flake8 listeners/
+
+# Run black from root directory for code formatting
+black .
+```
+
+## Project Structure
+
+### `manifest.json`
+
+`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.
+
+### `app.py`
+
+`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.
+
+### `/listeners`
+
+Every 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.
+
+## App Distribution / OAuth
+
+Only 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.
+
+When 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.
+
+Start `ngrok` to access the app on an external network and create a redirect URL for OAuth. 
+
+```
+ngrok http 3000
+```
+
+This output should include a forwarding address for `http` and `https` (we'll use `https`). It should look something like the following:
+
+```
+Forwarding   https://3cb89939.ngrok.io -> http://localhost:3000
+```
+
+Navigate to **OAuth & 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:
+
+```
+https://3cb89939.ngrok.io/slack/oauth_redirect
+```

app.py

@@ -0,0 +1,18 @@
+import os
+import logging
+
+from slack_bolt import App
+from slack_bolt.adapter.socket_mode import SocketModeHandler
+
+from listeners import register_listeners
+
+# Initialization
+app = App(token=os.environ.get("SLACK_BOT_TOKEN"))
+logging.basicConfig(level=logging.DEBUG)
+
+# Register Listeners
+register_listeners(app)
+
+# Start Bolt app
+if __name__ == "__main__":
+    SocketModeHandler(app, os.environ.get("SLACK_APP_TOKEN")).start()

app_oauth.py

@@ -0,0 +1,50 @@
+import logging
+import os
+from slack_bolt import App, BoltResponse
+from slack_bolt.oauth.callback_options import CallbackOptions, SuccessArgs, FailureArgs
+from slack_bolt.oauth.oauth_settings import OAuthSettings
+
+from slack_sdk.oauth.installation_store import FileInstallationStore
+from slack_sdk.oauth.state_store import FileOAuthStateStore
+
+from listeners import register_listeners
+
+logging.basicConfig(level=logging.DEBUG)
+
+
+# Callback to run on successful installation
+def success(args: SuccessArgs) -> BoltResponse:
+    # Call default handler to return an HTTP response
+    return args.default.success(args)
+    # return BoltResponse(status=200, body="Installation successful!")
+
+
+# Callback to run on failed installation
+def failure(args: FailureArgs) -> BoltResponse:
+    return args.default.failure(args)
+    # return BoltResponse(status=args.suggested_status_code, body=args.reason)
+
+
+# Initialization
+app = App(
+    signing_secret=os.environ.get("SLACK_SIGNING_SECRET"),
+    installation_store=FileInstallationStore(),
+    oauth_settings=OAuthSettings(
+        client_id=os.environ.get("SLACK_CLIENT_ID"),
+        client_secret=os.environ.get("SLACK_CLIENT_SECRET"),
+        scopes=["channels:history", "chat:write", "commands"],
+        user_scopes=[],
+        redirect_uri=None,
+        install_path="/slack/install",
+        redirect_uri_path="/slack/oauth_redirect",
+        state_store=FileOAuthStateStore(expiration_seconds=600),
+        callback_options=CallbackOptions(success=success, failure=failure),
+    ),
+)
+
+# Register Listeners
+register_listeners(app)
+
+# Start Bolt app
+if __name__ == "__main__":
+    app.start(3000)