Skip to main content

A light decorator around flask and slack to remove the boilerplate for handling Slack slash commands

Project description

flask-slack-template

A light decorator around flask and slack to remove the boilerplate for handling Slack slash commands

Example Usage:

from flask import Flask

from flaskslack.flaskslack import FlaskSlack
from flaskslack.slack import ResponseType, Slack

app = Flask(__name__)
# If you want to get your config in a non default way,
# you can create a slack client with: Slack('slack_oauth_token', 'slack_signing_secret')
slack = Slack.create()
flask_slack = FlaskSlack(app, slack)


# set verify_signature to False if you want to do some local testing
@flask_slack.slack_route('/slack/endpoint', response_type=ResponseType.IN_CHANNEL, verify_signature=True)
def get_channel_member_ids(form_content):
    """
    :param form_content: a dict containing the data payload from the slack HTTP POST
            see: https://api.slack.com/slash-commands#app_command_handling
    :return: It should return a dict. The dict should contain a 'text' field, and/or a list of 'attachments'.
            see: https://api.slack.com/slash-commands#responding_immediate_response
    """

    channel_id = form_content["channel_id"]
    members_form_content = slack.try_api_call("conversations.members", channel=channel_id)
    channel_member_ids = members_form_content["members"]

    text_response = f"The channel_member_ids for channel_id {channel_id} is: {channel_member_ids}"
    return Slack.create_response(text_response)


if __name__ == "__main__":
    app.run(host="localhost")

Installation:

  • pip install flask_slack_template
  • Create a file called config.json in the root directory with the slack oauth token and signing secret
    {
      "SLACK_OAUTH_TOKEN": "YOUR_TOKEN_HERE",
      "SLACK_SIGNING_SECRET": "YOUR_SECRET_HERE"
    }
    
    # main.py   
    
    slack = Slack.create()
    # If you want to get your config in a non default way,
    # you can create a slack client with: Slack('slack_oauth_token', 'slack_signing_secret')
    # slack = Slack('slack_oauth_token', 'slack_signing_secret')
    
    • You can find your oauth token and signing secret here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_slack_template-0.0.4.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

flask_slack_template-0.0.4-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file flask_slack_template-0.0.4.tar.gz.

File metadata

  • Download URL: flask_slack_template-0.0.4.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for flask_slack_template-0.0.4.tar.gz
Algorithm Hash digest
SHA256 3ba7193e81ceaa768aafd56702ad5ebd99d33e4b887555d6885cebec7ddabdd6
MD5 e79cdd4ed00edacb64f89b36ca111f55
BLAKE2b-256 ab43eaf1ad0560d58e3d10a9e99f861268a568611a826c29325efa50ee66d86c

See more details on using hashes here.

File details

Details for the file flask_slack_template-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: flask_slack_template-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for flask_slack_template-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6e63be93158a59dc486aa98ac982ec7d6a21c37dc30e6ec90ddbae21e5ecf4fe
MD5 2042e3d8c92f62e7ba3d39ae84a46518
BLAKE2b-256 07345f750a8544d0b9e93ae52fe39fb163b6fa3af6cdb47b6e16fcb3e6b30d22

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page