Skip to main content

A fast way to build Block Kit interfaces in Python

Project description

blockkit-logo

Build status PyPI version Downloads


Documentation: https://blockkit.botsignals.co

Source Code: https://github.com/imryche/blockkit


BlockKit for Python

Build beautiful Slack UIs fast. Fluent API with type hints, validation, and zero dependencies.

pip install blockkit

Here's the thing

Building Slack apps shouldn't feel like writing JSON by hand. It's tedious. It's error prone. And honestly? It's a waste of your time.

You know what you want to build. Your editor should help you build it. That's what BlockKit for Python does.

Before

This is what you're probably doing now:

# Building a simple approval message. What could go wrong?
message = {
    "blocks": [{
        "type": "section",
        "text": {
            "type": "mrkdwn",  # 🤔 or was it "markdown"?
            "text": "Please approve *Alice's* expense report for $42"
        },
        "accessory": {
            "type": "button",
            "text": {
                "type": "plain_text",  # 😕 wait, why can't buttons use mrkdwn?
                "text": "Approve"      # 🤞 hope this isn't too long
            },
            "action_id": "approve_button",
            "style": "green",  # ❌ is it "green"? "success"? "primary"?
            "confirm": {       # 🤔 what's the structure again?
                "title": {
                    "type": "plain_text",
                    "text": "Are you sure?"
                },
                "text": {
                    "type": "plain_text",
                    "text": "This action cannot be undone"
                },
                "confirm": {
                    "type": "plain_text",
                    "text": "Yes, approve"
                }
                # ❌ forgot the required "deny" field
            }
        }
    }],
    "thread_ts": 1234567890  # ❌ wait, should this be a string?
}

# Three bugs. Deeply nested JSON. Good luck debugging this.

Nest some JSON. Guess field names. Cross your fingers. Test it. Get an error. Try again. Sound familiar?

After

Here's the same thing:

from blockkit import Message, Section, Button, Confirm

message = (
    Message()
    .add_block(
        Section("Please approve *Alice's* expense report for $42")  # ✅ Markdown detected automatically
        .accessory(
            Button("Approve")
            .action_id("approve_button")
            .style(Button.PRIMARY)  # ✅ Class constants prevent typos
            .confirm(
                Confirm()
                .title("Are you sure?")
                .text("This action cannot be undone")
                .confirm("Yes, approve")
                .deny("Cancel")  # ✅ Can't forget required fields
            )
        )
    )
    .thread_ts(1234567890)  # ✅ Converts types automatically
    .build()  # ✅ Validates everything: types, lengths, required fields
)

# Clean. Readable. BlockKit catches errors before you event send it to Slack.

Done. No guessing. No runtime surprises. Your editor helped you write it.

The difference

The library knows Slack's rules, so you don't have to memorize them. Your editor autocompletes everything. Validation happens immediately.

When something's wrong, you'll know right away - not after deploying.

Real example

Let's build something real. An approval flow:

from blockkit import Modal, Section, Input, PlainTextInput, RadioButtons, Option

modal = (
    Modal()
    .title("Expense Approval")
    .add_block(Section("*New expense request from Alice*"))
    .add_block(
        Input("Amount").element(
            PlainTextInput().initial_value("$42.00").action_id("amount")
        )
    )
    .add_block(
        Input("Decision").element(
            RadioButtons()
            .add_option(Option("Approve ✅", "approve"))
            .add_option(Option("Reject ❌", "reject"))
            .action_id("decision")
        )
    )
    .submit("Submit")
    .build()
)

That's it. Clear, readable, and it works the first time.

Why we built this

We got tired of:

  • Reading Slack's docs for the 100th time
  • Building UIs that are impossible to refactor
  • Shipping "perfect" JSON that Slack rejects for mysterious reasons

So we fixed it. One library. No dependencies. Just better.

Want more?

Check out blockkit.botsignals.co for the full docs. Or don't. The code is pretty self-explanatory.


Made by Botsignals

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-2.1.3.tar.gz (67.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

blockkit-2.1.3-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: blockkit-2.1.3.tar.gz
  • Upload date:
  • Size: 67.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for blockkit-2.1.3.tar.gz
Algorithm Hash digest
SHA256 f71de30029afdce3e7cd3d869519c7207788e419267898acd6445d471b112215
MD5 cd74530f08dc89df759ddcc362a4fb3f
BLAKE2b-256 3d9bef26b291946a79bd295d0d7a70ca8e109e0a7b4ea13620da969101d71f38

See more details on using hashes here.

File details

Details for the file blockkit-2.1.3-py3-none-any.whl.

File metadata

  • Download URL: blockkit-2.1.3-py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for blockkit-2.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d92c30296770de6a8a4f0ac30fa6f6c78881c45a22d808bdb33767cfa0ea7bb9
MD5 90072a5702b7d707b10d560341152c1a
BLAKE2b-256 30ae5fcb4710c070bf2d51a4f90baf58105b211499f09c311b93b840dc5a0c06

See more details on using hashes here.

Supported by

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