Skip to main content

A Django app for handling Slack webhooks

Project description

# django-slack-utils [![Build Status](https://travis-ci.com/startmatter/django-slack-utils.svg?branch=master)](https://travis-ci.com/startmatter/django-slack-utils) [![Coverage Status](https://coveralls.io/repos/github/startmatter/django-slack-utils/badge.svg?branch=master)](https://coveralls.io/github/startmatter/django-slack-utils?branch=master)

Django-slack-utils is helper application to handle Slack requests.

It supports verification through `HTTP_X_SLACK_SIGNATURE` and `HTTP_X_SLACK_REQUEST_TIMESTAMP`.

## Installation
Add the following to your `settings.py`
```python
INSTALLED_APPS = [
...
'slack_utils',
]

SLACK_SIGNING_SECRET = 'your signing secret from Slack'

```

Add the following to your `urls.py`
```python
from django.conf.urls import include
from django.urls import path

urlpatterns = [
...
path('slack/', include('slack_utils.urls')),
]

```

## Usage

### View decorator
The `@slack_view` decorator adds CSRF exempt and verification to your function-based django view.

```python
from slack_utils.decorators import slack_view
from django.http import HttpResponse

@slack_view
def sample_view(request, *args, **kwargs):
# your logic
return HttpResponse("Hello!")

```


### Class-based view

The `SlackView` base class adds CSRF exempt and verification to your class-based django view.

```python
from slack_utils.views import SlackView
from django.http import HttpResponse

class SampleView(SlackView):
def post(self, request, *args, **kwargs):
# your logic
return HttpResponse("Hello!")

```


### Slash commands
To handle [Slack slash commands](https://api.slack.com/slash-commands), point the command URL to `/slack/commands/`.

Now just add a handler function to `slack.py` module of your app.

```python
from slack_utils.decorators import slack_command

@slack_command('/test')
def test_command(text, **kwargs):
# your logic
return "Hello!" # or {'text': "hello!"}

```

`**kwargs`would get the rest of the data from Slack request

### Events API

Point [Slack events API](https://api.slack.com/events-api) to the `/slack/events/`.

Subscription can be done in two ways:

#### Receiver decorator
Put them into `slack.py` of your app or make sure it's loaded once.

```python
from slack_utils.decorators import slack_receiver

@slack_receiver('reaction_added')
def on_reaction_added(event_data, **kwargs):
# your logic

```

#### Signal

```python
from slack_utils.signals import event_received
from django.dispatch import receiver

@receiver(event_received)
def on_event_received(sender, event_type, event_data, **kwargs):
if event_type == 'reaction_added':
# your logic

# your other logic

```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-slack-utils-0.3.0.tar.gz (4.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page