Skip to main content

A python3 wrapper for the slack block kit framework

Project description

Slack Blocks Wrapper

Slack blocks wrapper is a python3 wrapper around the slack blocks framework. It provides a simple way to create and send blocks to slack.

Installation

pip install slack-blocks-wrapper

Slack blocks wrapper has no dependencies outside python3. Currently, it is only supported and tested on python3.9.

Usage

You can use the wrapper to create blocks in a few different ways.

Here's an example of a section with a multi-static select menu:

from slack_blocks_wrapper import section

multistatic_select_node = section.multistatic_select_element(
    placeholder="Select a color",
    action_id="color_select",
    options=[
        section.text_node(
            text="Red",
            text_type=section.TextType.PLAIN_TEXT,
            value="red"
        ),
        section.text_node(
            text="Green",
            text_type=section.TextType.PLAIN_TEXT,
            value="green"
        ),
        section.text_node(
            text="Blue",
            text_type=section.TextType.PLAIN_TEXT,
            value="blue"
        )
    ]
)

You can use this element with the Bolt framework to create a multi-static select menu as follows:

import logging
import os
from flask import Flask
from slack_bolt import App

from slack_bolt.adapter.flask import SlackRequestHandler
from slack_blocks_wrapper import section

block_element = section.multistatic_select_element(
    placeholder="Select a color",
    action_id="color_select",
    options=[
        section.text_node(
            text="Red",
            text_type=section.TextType.PLAIN_TEXT,
            value="red"
        ),
        section.text_node(
            text="Green",
            text_type=section.TextType.PLAIN_TEXT,
            value="green"
        ),
        section.text_node(
            text="Blue",
            text_type=section.TextType.PLAIN_TEXT,
            value="blue"
        )
    ]
)
app = Flask(__name__)
handler = SlackRequestHandler(bolt_app)
logging.basicConfig(level=logging.DEBUG)
bolt_app = App()


@bolt_app.command("/hello-world")
def hello(ack):
    ack(blocks=[block_element])


@app.route("/slack/events", methods=["POST"])
def slack_events():
    return handler.handle(request)


# Only for local debug
if __name__ == "__main__":
    app.run(debug=True, host="0.0.0.0", port=int(os.environ.get("PORT", 3000)))

Thus far, the following block kit builder elements are supported:

  1. Section - All section elements are supported.
  2. Actions - All action elements are supported.
  3. Context - All context elements are supported.
  4. Divider - All divider elements are supported.
  5. Image - All image elements are supported.
  6. Input - All input elements are supported.
  7. Header - All header elements are supported.
  8. Divider - All divider elements are supported.

Better documentation and implementation improvements are coming soon.

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

slack-blocks-wrapper-0.1.1.tar.gz (12.0 kB view hashes)

Uploaded Source

Built Distribution

slack_blocks_wrapper-0.1.1-py3-none-any.whl (18.5 kB view hashes)

Uploaded Python 3

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