Skip to main content

Simplified serverless Slack bot interactions

Project description

Utility library for serverless Slack apps

PyPI

This is a (currently very simple) library that eases development of serverless Slack app and bots.

Currently, it targets Google Cloud Platform (but is easily generalised), and provides a decorator and some utility functions that make Slack signature verification automatic and help with building responses in a very lightweight fashion.

I will grow it with things I end up needing in my work, but if you have different needs and want to extend the library to support them, then PRs would be gratefully received!

MVP Example

This will accept any slash command you've configured for your bot, and just greet the user who calls it, tagging them in the reply.

from slack_serverless import slack_slash_command_gcp
from slack_messaging import slack_in_channel_text_response, slack_tags

@slack_slash_command_gcp(slack_signing_key=YOUR_SIGNING_KEY)
def command_handler(payload):
    return slack_in_channel_text_response(f"Hi there <@{slack_tags([payload['user_id']])}>")

Other Cloud Providers

Things will be a bit more manual here (but I'll happily add comfort wrappers if there's enough call and a PR that contributes them 😉).

The easiest thing to do is use the slack_slash_command decorator, which is similar to the gcp one above but needs you pass in a couple of Callables the code will use to get access to the data in a provider-specific way.

Take a look at the code in slack_serverless.py for examples to get you started.

Developing

Don't forget to set up pre-commit if you're developing things, especially if you plan to push a PR.

Legal Mumbo-Jumbo

Copyright (c)2023 Ross Bamford (and contributors)

License: MIT (see LICENSE.md for details).

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

slack-serverless-2023.1004a0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

slack_serverless-2023.1004a0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file slack-serverless-2023.1004a0.tar.gz.

File metadata

File hashes

Hashes for slack-serverless-2023.1004a0.tar.gz
Algorithm Hash digest
SHA256 eade8be60769179e4d4422b8d5b06fd246e8d569b58390571baf3071b957a3df
MD5 efec767728b934cde3351398f82688c5
BLAKE2b-256 0a2c73ee38c9f09d75fd9665cab0120fdadd1f60d209d6da263bac24aa3d809e

See more details on using hashes here.

File details

Details for the file slack_serverless-2023.1004a0-py3-none-any.whl.

File metadata

File hashes

Hashes for slack_serverless-2023.1004a0-py3-none-any.whl
Algorithm Hash digest
SHA256 972652cdb27469bd763ced0960d682f9832fffed6a04a7613561d8cf7ce6374a
MD5 e9934dbfc04344ffd4cd45d0e0f8e63c
BLAKE2b-256 27ce02351e1186b360e6fd42d63880c29e59e6f277b1e48d374c2f0f6fad0f45

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