Skip to content
Django app made to integrate generic events that create notifications that can be sent to users using several backends.
Python HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
snitch
tests
.gitignore
.travis.yml
AUTHORS.rst
HISTORY.rst
LICENSE
Pipfile
Pipfile.lock
README.rst
manage.py
pyproject.toml
pytest.ini

README.rst

Django Snitch

https://travis-ci.org/marcosgabarda/django-snitch.svg?branch=master https://coveralls.io/repos/github/marcosgabarda/django-snitch/badge.svg?branch=master

Django app made to integrate generic events that create notifications that can be sent to users using several backends.

By default, it integrates push notifications and email to send the notifications.

Made with Python 3 and Django with ❤️.

Quick start

1 Install using pip:

pip install django-snitch

2 Add "snitch" to your INSTALLED_APPS settings like this:

INSTALLED_APPS += ('snitch',)

3 Create an events.py file in your app to register the events:

import snitch
from snitch.backends import PushNotificationBackend, EmailNotificationBackend

ACTIVATED_EVENT = "activated"
CONFIRMED_EVENT = "confirmed"


@snitch.register(ACTIVATED_EVENT)
class ActivatedHandler(snitch.EventHandler):
    title = "Activated!"


@snitch.register(CONFIRMED_EVENT)
class ConfirmedHandler(snitch.EventHandler):
    title = "Confirmed!"
    notification_backends = [PushNotificationBackend, EmailNotificationBackend]

    # Custom configuration for email backend
    template_email_kwargs = {"template_name": "email.html"}
    template_email_async = False

    def audience(self):
        return get_user_model().objects.all()

4 Use dispatch decorator to dispatch the event when a function is called:

from django.db import models
from django.utils import timezone

import snitch
from snitch.models import AbstractNotification
from tests.app.events import ACTIVATED_EVENT, CONFIRMED_EVENT


class Stuff(models.Model):
    """Simple stuff model with status."""

    IDLE, ACTIVE, CONFIRMED = 0, 1, 2
    status = models.PositiveIntegerField(default=IDLE)
    activated_at = models.DateTimeField(null=True, blank=True)
    confirmed_at = models.DateTimeField(null=True, blank=True)

    @snitch.dispatch(ACTIVATED_EVENT)
    def activate(self):
        self.activated_at = timezone.now()

    @snitch.dispatch(CONFIRMED_EVENT)
    def confirm(self):
        self.confirmed_at = timezone.now()

Custom Notification model

You can, in the same way that django.contrib.auth.model.User works, swap the Notification model, to customize it.

In order to do thar, you should create a model that inherits from AbstractNotification:

from django.db import models

from snitch.models import AbstractNotification


class Notification(AbstractNotification):
    """Custom notification."""

    extra_field = models.BooleanField(default=False)

An after that, specify it in the settings:

SNITCH_NOTIFICATION_MODEL = "app.Notification"
You can’t perform that action at this time.