Skip to main content

A fast way to build Block Kit interfaces in Python.

Project description

Screenshot

Build Status PyPI version Downloads


Blockkit is a Python library for building UI interfaces for Slack apps. It allows you to compose the interface from Python classes, so you type less, and your code becomes more maintainable.

Blockkit performs validation at runtime and provides user-friendly errors when data is invalid.

Generate

You don't even need to write code yourself. Go to blockkit-generator.com paste your JSON payload from Block Kit Builder and get corresponding Python code!

Screenshot

Installation

pip install blockkit

Usage

Start with one of the Home, Modal, or Message surface classes and follow the structure as you would follow it in JSON.

The library supports all types of surfaces, blocks, block elements, and composition objects Slack provides.

Once UI is ready, call the build() method to render components to dictionary:

from blockkit import Section, MarkdownText

Section(text=MarkdownText(text="hello world")).build()

{"type": "section", "text": {"text": "hello world", "type": "mrkdwn"}}

Here's the list of types of components and corresponding classes:

Surfaces

Type Class
home Home
modal Modal
Message

Blocks

Type Class
actions Actions
context Context
divider Divider
header Header
image ImageBlock
input Input
section Section

Block elements

Type Class
button Button
checkboxes Checkboxes
datepicker DatePicker
type Image
multi_static_select MultiStaticSelect
multi_users_select MultiUsersSelect
multi_channels_select MultiChannelsSelect
multi_conversations_select MultiConversationsSelect
multi_external_select MultiExternalSelect
overflow Overflow
plain_text_input PlainTextInput
radio_buttons RadioButtons
static_select StaticSelect
users_select UsersSelect
channels_select ChannelsSelect
conversations_select ConversationsSelect
external_select ExternalSelect

Composition objects

Type Class
plain_text PlainText
mrkdwn MarkdownText
Confirm
Option
OptionGroup
Filter
DispatchActionConfig

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

Uploaded Source

Built Distribution

blockkit-1.0.2-py2.py3-none-any.whl (13.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: blockkit-1.0.2.tar.gz
  • Upload date:
  • Size: 12.1 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.11

File hashes

Hashes for blockkit-1.0.2.tar.gz
Algorithm Hash digest
SHA256 0212261e01403d97dbf420eed68d6177bba5ef9a8776c9ec661434ae91fafa09
MD5 cef9df6499cf3ce011f4e59120ac1cc7
BLAKE2b-256 ccc841fd3cbbdc874ad6fb31bb5ac0be6f430692532e743b585bc964caca6183

See more details on using hashes here.

File details

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

File metadata

  • Download URL: blockkit-1.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.4 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.11

File hashes

Hashes for blockkit-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 86acfbf2f670c9bbf40f27ef36bdab4718e9359edd6c846ab12a83a2d5dbddc5
MD5 6916f071e1c218d4c3aa61ee27300dcc
BLAKE2b-256 c6e3ece556eb08948008c9c2022cc8bae4b6beaef4cdd3f5f5a8749e406ce256

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