{"id":13821002,"url":"https://github.com/imryche/blockkit","last_synced_at":"2025-05-16T16:08:05.918Z","repository":{"id":37799012,"uuid":"217035972","full_name":"imryche/blockkit","owner":"imryche","description":"A fast way to build Block Kit interfaces in Python","archived":false,"fork":false,"pushed_at":"2025-05-11T16:08:59.000Z","size":1123,"stargazers_count":80,"open_issues_count":5,"forks_count":16,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-11T17:21:37.588Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"https://blockkit.botsignals.co","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imryche.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-10-23T11:01:11.000Z","updated_at":"2025-04-19T02:12:46.000Z","dependencies_parsed_at":"2024-01-13T21:17:15.300Z","dependency_job_id":"62d952f9-2fbd-4256-b062-5d5e6a6f6d49","html_url":"https://github.com/imryche/blockkit","commit_stats":{"total_commits":280,"total_committers":9,"mean_commits":31.11111111111111,"dds":"0.25357142857142856","last_synced_commit":"8a90c1813df4fc796ed27d76e42f05d673846fdb"},"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imryche%2Fblockkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imryche%2Fblockkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imryche%2Fblockkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imryche%2Fblockkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imryche","download_url":"https://codeload.github.com/imryche/blockkit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254564127,"owners_count":22092122,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2024-08-04T08:01:13.462Z","updated_at":"2025-05-16T16:08:05.890Z","avatar_url":"https://github.com/imryche.png","language":"Python","readme":"![Screenshot](https://github.com/imryche/blockkit/raw/master/images/logo.png)\n\n![Build status](https://github.com/imryche/blockkit/actions/workflows/python-app.yml/badge.svg)\n[![PyPI version](https://badge.fury.io/py/blockkit.svg)](https://badge.fury.io/py/blockkit)\n[![Downloads](https://static.pepy.tech/badge/blockkit)](https://pepy.tech/project/blockkit)\n\n---\n\nBlockkit 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.\n\nBlockkit performs validation at runtime and provides user-friendly errors when data is invalid.\n\n## Generate\n\nYou 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!\n\n![Screenshot](https://github.com/imryche/blockkit/raw/master/images/generator.png)\n\n## Installation\n\n```bash\npip install blockkit\n```\n\n## Usage\n\nStart with one of the `Home`, `Modal`, or `Message` surface classes and follow the structure as you would follow it in JSON.\n\nThe 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.\n\nOnce UI is ready, call the `build()` method to render components to dictionary:\n\n```python\nfrom blockkit import Section, MarkdownText\n\nSection(text=MarkdownText(text=\"hello world\")).build()\n\n{\"type\": \"section\", \"text\": {\"text\": \"hello world\", \"type\": \"mrkdwn\"}}\n```\n\nHere's the list of types of components and corresponding classes:\n\n### Surfaces\n\n| Type          | Class        |\n| ------------- | ------------ |\n| home          | Home         |\n| modal         | Modal        |\n|               | Message      |\n| workflow_step | WorkflowStep |\n\n### Blocks\n\n| Type      | Class      |\n| --------- | ---------- |\n| actions   | Actions    |\n| context   | Context    |\n| divider   | Divider    |\n| header    | Header     |\n| image     | ImageBlock |\n| input     | Input      |\n| rich_text | RichText   |\n| section   | Section    |\n\n### Block elements\n\n| Type                       | Class                    |\n| -------------------------- | ------------------------ |\n| button                     | Button                   |\n| checkboxes                 | Checkboxes               |\n| datepicker                 | DatePicker               |\n| datetimepicker             | DatetimePicker           |\n| type                       | Image                    |\n| multi_static_select        | MultiStaticSelect        |\n| multi_users_select         | MultiUsersSelect         |\n| multi_channels_select      | MultiChannelsSelect      |\n| multi_conversations_select | MultiConversationsSelect |\n| multi_external_select      | MultiExternalSelect      |\n| overflow                   | Overflow                 |\n| plain_text_input           | PlainTextInput           |\n| radio_buttons              | RadioButtons             |\n| static_select              | StaticSelect             |\n| users_select               | UsersSelect              |\n| channels_select            | ChannelsSelect           |\n| conversations_select       | ConversationsSelect      |\n| external_select            | ExternalSelect           |\n| timepicker                 | TimePicker               |\n| rich_text_list             | RichTextList             |\n| rich_text_preformatted     | RichTextPreformatted     |\n| rich_text_quote            | RichTextQuote            |\n| rich_text_section          | RichTextSection          |\n| file_input                 | FileInput                |\n\n### Composition objects\n\n| Type       | Class                |\n| ---------- | -------------------- |\n| plain_text | PlainText            |\n| mrkdwn     | MarkdownText         |\n| text       | Text                 |\n| emoji      | Emoji                |\n|            | Style                |\n|            | Confirm              |\n|            | PlainOption          |\n|            | MarkdownOption       |\n|            | OptionGroup          |\n|            | Filter               |\n|            | DispatchActionConfig |\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","funding_links":[],"categories":["Python",":hammer_and_wrench: \u0026nbsp; Libraries and SDKs"],"sub_categories":["Python"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimryche%2Fblockkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimryche%2Fblockkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimryche%2Fblockkit/lists"}