Skip to main content

A fast way to build Block Kit interfaces in Python.

Project description

blockkit-slack

Build Status

A fast way to build Block Kit interfaces in Python

Installation

Use the package manager pip to install blockkit.

pip install blockkit

Usage

from blockkit import Message, Section, Actions, MarkdownText, Button


message = Message(
    blocks=[
        Section(MarkdownText("You have a new request")),
        Section(
            fields=[
                MarkdownText("*Type:*\nComputer (laptop)"),
                MarkdownText("*When:*\nSubmitted Aut 10"),
                MarkdownText("*Last Update:*\nMar 10, 2015 (3 years, 5 months)"),
                MarkdownText("*Reason:*\nAll vowel keys aren't working."),
                MarkdownText("*Specs:*\nCheetah Pro 15 - Fast, really fast"),
            ],
        ),
        Actions(
            [
                Button("Approve", style=Button.primary, action_id="approve"),
                Button("Decline", style=Button.danger, action_id="decline"),
                Button("Discuss", action_id="discuss"),
            ]
        ),
    ]
)

message = message.build()

Viewing Blocks in Block UI Builder

Visualize in the Slack's Block Kit Builder:

message = Message(
    blocks=[
        Section(text="HELLLOOOO WORLD!")
        ]
)

"""
outputs:
Block kit builder example/validation:  
	https://app.slack.com/block-kit-builder/#%7B%22blocks%22:%20%5B%7B%22type%22:%20%22section%22%2C%20%22text%22:%20%7B%22text%22:%20%22HELLLOOOO%20WORLD%21%22%2C%20%22type%22:%20%22plain_text%22%2C%20%22emoji%22:%20true%7D%7D%5D%7D
"""
create_block_kit_builder_url(message)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

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

blockkit-0.9.1.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

blockkit-0.9.1-py2.py3-none-any.whl (10.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file blockkit-0.9.1.tar.gz.

File metadata

  • Download URL: blockkit-0.9.1.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for blockkit-0.9.1.tar.gz
Algorithm Hash digest
SHA256 16b2257fe5f4109524fc6e722128043eeecb8d95b47b0c6fea45d33bdf4bc5ae
MD5 89754ba0ffe6749958012bb4fa4380c1
BLAKE2b-256 77fd3be8107cd28e2bb9e40dab38351210e9229bd10362fb41c7e5eac2f65978

See more details on using hashes here.

File details

Details for the file blockkit-0.9.1-py2.py3-none-any.whl.

File metadata

  • Download URL: blockkit-0.9.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for blockkit-0.9.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d140fe3744ef1939ddc15481d57307e393db2e9d372040526c2fbaeca76a3243
MD5 352acf79c6064f884d282f2142cd1ca2
BLAKE2b-256 363f65ae5428fbfed7957f3001a24a30bd49540d8ba2262eed89cf0977623ab3

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