Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imryche/blockkit
A fast way to build Block Kit interfaces in Python
https://github.com/imryche/blockkit
blockkit bot-application bot-framework python slack slack-actions slack-api slack-app slack-block slack-bot slack-bots slack-commands slack-hacks slack-interactions slack-modals slack-notifications slack-webhook slackapi slackbot
Last synced: 2 months ago
JSON representation
A fast way to build Block Kit interfaces in Python
- Host: GitHub
- URL: https://github.com/imryche/blockkit
- Owner: imryche
- License: mit
- Created: 2019-10-23T11:01:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T13:25:08.000Z (3 months ago)
- Last Synced: 2024-03-21T10:39:53.688Z (3 months ago)
- Topics: blockkit, bot-application, bot-framework, python, slack, slack-actions, slack-api, slack-app, slack-block, slack-bot, slack-bots, slack-commands, slack-hacks, slack-interactions, slack-modals, slack-notifications, slack-webhook, slackapi, slackbot
- Language: Python
- Homepage: https://blockkit.botsignals.co
- Size: 757 KB
- Stars: 65
- Watchers: 2
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - imryche/blockkit - A fast way to build Block Kit interfaces in Python (Python)
- awesome-slack - blockkit - A fast way to build Block Kit interfaces in Python (:hammer_and_wrench: Libraries and SDKs / Python)
README
[](https://badge.fury.io/py/blockkit)
[](https://pepy.tech/project/blockkit)
---
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 [https://blockkit.botsignals.co](https://blockkit.botsignals.co) paste your JSON payload from [Block Kit Builder](https://api.slack.com/tools/block-kit-builder) and get corresponding Python code!
## Installation
```bash
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](https://api.slack.com/surfaces), [blocks](https://api.slack.com/block-kit), [block elements](https://api.slack.com/block-kit), and [composition objects](https://api.slack.com/block-kit) Slack provides.
Once UI is ready, call the `build()` method to render components to dictionary:
```python
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 |
| workflow_step | WorkflowStep |
### Blocks
| Type | Class |
| --------- | ---------- |
| actions | Actions |
| context | Context |
| divider | Divider |
| header | Header |
| image | ImageBlock |
| input | Input |
| rich_text | RichText |
| section | Section |
### Block elements
| Type | Class |
| -------------------------- | ------------------------ |
| button | Button |
| checkboxes | Checkboxes |
| datepicker | DatePicker |
| datetimepicker | DatetimePicker |
| 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 |
| timepicker | TimePicker |
| rich_text_list | RichTextList |
| rich_text_preformatted | RichTextPreformatted |
| rich_text_quote | RichTextQuote |
| rich_text_section | RichTextSection |
| file_input | FileInput |
### Composition objects
| Type | Class |
| ---------- | -------------------- |
| plain_text | PlainText |
| mrkdwn | MarkdownText |
| text | Text |
| emoji | Emoji |
| | Style |
| | Confirm |
| | PlainOption |
| | MarkdownOption |
| | 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](https://choosealicense.com/licenses/mit/)