duvholt / django-nyt

Notification system for Django with batteries included: Email digests, user settings, JSON API

django-nyt

django_nyt does this:

from django_nyt import notify

EVENT_KEY = "my_key"
notify(_("OMG! Something happened"), EVENT_KEY)

All users subscribing to EVENT_KEY will have a notification created in their stack. If you have emails enabled, they may get a summary of notifications at an interval of their choice.

Data can be accessed easily from Django models or from the included JSON views.

Why should you do this?

Users need an cleverly sifted stream of events. Ensure that they have the possibility of customizing what they deem fit for their stream.

What do you need to do?

You need to do a lot. Firstly, you need to write some javascript that will fetch the latest notifications and display them in some area of the screen. Upon clicking that icon, the latest notifications are displayed. Something like this:

Some examples are provided, but there is no real easy way to place this nifty little thing at the top of your site.

Other things for your TODO list:

• Provide your users with options to customize their subscriptions and notification preferences.
• Customize contents of notification emails
• Make the mail notification daemon script run python manage.py notifymail --daemon
• Put calls to notify(...) where ever necessary.

Docs

Here:

http://django-nyt.readthedocs.org/en/latest/

Community

Please visit #django-wiki on irc.freenode.net as many django-wiki users are also familiar with django-nyt which previously lived inside django-wiki.

Development

In your Git fork, run pip install -r requirements.txt to install the requirements.

The folder testproject/ contains a pre-configured django project and an sqlite database. Login for django admin is admin:admin.

This is a work in progre..

Please refer to the TODO