EzSlack

EzSlack is a Python framework wrapping Bolt for Python to provide useful utilities.

• Encapsule parsing low-level information
• Provide Handler class to improve cohesion

Get Started

from ezslack import App

# Running over HTTP
app = App(token=SLACK_BOT_TOKEN, signing_secret=SLACK_SIGNING_SECRET)
app.start(PORT)

# Running in Socket Mode
app = App(token=SLACK_BOT_TOKEN)
app.start_socket_mode(SLACK_APP_TOKEN)

Handler

Whenever subclass of Handler is defined, handler methods are registered in REGISTRIES. String arguments in handler decorator are automatically converted into regex pattern with anchors. Matched groups are passed to arguments and keyword arguments whether they are named.

from ezslack import Handler, message

class MyHandler(Handler):
    @message("hello", "hi")
    def greet(self):
        self.ack()
        self.say(
            f"Nice to meet you <@{self.user_id}>",
            thread_ts=self.thread_ts,
        )

    @message(r"(?P<first>\w+)(?P<op>[+*])(?P<second>\w+)")
    def calculate(self, first, second, op):
        if op == "+":
            result = int(first) + int(second)
        else:
            result = int(first) * int(second)
        self.say(f"Result: {result}", thread_ts=self.thread_ts)

Supported features

Requests supported: ACTION, MESSAGE, VIEW_CLOSED, VIEW_SUBMISSION

Each request has an id such as action_id, message.text, callback_id. When a request id matches handling method's regex pattern, handler is instantiated with the following context fields, then call the method.