slack-app

• quick start
  • pre-work
  • run slack-app
  • run slack-app with docker
• github
  • codespaces
  • actions
• development
• deploy slack-app
• reference
• misc

quick start

pre-work

• create the ENV_VARS file containing the SLACK_BOT_TOKEN and SLACK_APP_TOKEN

  SLACK_BOT_TOKEN=xoxb-<REPLACEME>
  SLACK_APP_TOKEN=xapp-<REPLACEME>
  

• install the requirements and activate the virtual environment, see the pre-work section in docs/development.md for more details

run slack-app

• export the environment variables

  source ~/.secrets/ENV_VARS

• run app.py

  export PYTHONPATH=.; export SLACK_BOT_TOKEN; export SLACK_APP_TOKEN; python slackapp/app.py

run slack-app with docker

• pull the image locally

  docker pull ghcr.io/markgreene74/slack-app:latest

• start the container

  docker run \
      --env-file ~/.secrets/ENV_VARS \
      --rm \
      slack-app

github

codespaces

A devcontainer.json file has been added for custom Codespaces which include pre-commit hooks. See the GitHub documentation about creating a codespace to work on slack-app.

actions

Multiple GitHub Actions (workflow) are configured to ensure automated testing, linting and security scans (Snyk).

Actions:

	on push	on PR	schedule	run manually
CodeQL	main	main	Y	N
Build and publish	main	N	N	Y
Run tests and lint	main, feature/**	main	N	Y
Release	main	main	N	N
Snyk	main	main	N	N

development

See: docs/development.md

deploy slack-app

See: docs/running-slack-app.md

miscellanea

See: docs/miscellanea.md

reference

• PyPI
  • PyPI - slack-sdk
  • PyPI - slack-bolt
• github
  • GitHub - Slack Developer Kit for Python
• slack.com
  • Slack - api
  • Slack - apps
  • Slack - Block Kit Builder
• slack.dev/bolt-python
  • Slack Bolt - Getting started
  • Slack Bolt - concepts