Python wrapper for the Slack Blocks API
Project description
slackblocks ![](https://pypi-camo.freetls.fastly.net/9e8f5b5df3d8c66c7d094fb29ef8e20595c40b4f/68747470733a2f2f6769746875622e636f6d2f6e69636b6c616d626f75726e652f736c61636b626c6f636b732f7261772f6d61737465722f646f63732f696d672f73622e706e67)
What is it?
slackblocks
is a Python API for building messages in the fancy new Slack Block Kit API.
It was created by Nicholas Lambourne for the UQCS Slack Bot because he hates writing JSON.
As it turns out, the functionality that he was actually after exists in the outdated Slack Secondary Attachments API, but he was already in too deep to turn back.
N.B: This is still WIP software and I some of the more tricky interactive Block elements have yet to be implemented.
Requirements
slackblocks
requires Python >= 3.6.
As of version 0.1.0 it has no dependencies outside the Python standard library.
Installation
pip install slackblocks
Usage
from slackblocks import Message, SectionBlock
block = SectionBlock("Hello, world!")
message = Message(channel="#general", blocks=block)
message.json()
Will produce the following JSON string:
{
"channel": "#general",
"mrkdwn": true,
"blocks": [
{
"type": "section",
"block_id": "992ceb6b-9ad4-496b-b8e6-1bd8a632e8b3",
"text": {
"type": "mrkdwn",
"text": "Hello, world!",
"verbatim": false
}
}
]
}
Which can be sent as payload to the Slack message API HTTP endpoints.
Of more practical use is the ability to unpack the objects directly into the Python Slack Client to send messages:
from os import environ
from slack import WebClient
from slackblocks import Message, SectionBlock
client = WebClient(token=environ["SLACK_API_TOKEN"])
block = SectionBlock("Hello, world!")
message = Message(channel="#general", blocks=block)
response = client.chat_postMessage(**message)
Note the **
operator in front of the message
object.
Can I use this in my project?
Yes, please do! The code is all open source and BSD-3.0 licensed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for slackblocks-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7ae68f39fc9e056ee34c50777303bcc3a9f0a8ef401077165b2b586e311f4ac |
|
MD5 | c9ca28d73fede0b5e4e84ca59a21114e |
|
BLAKE2b-256 | 18e38030825911c020d6e130a029e2746a6b139b3756f9c92fdb178f63e0cd9f |