django-nyt 0.9.9

A pluggable notification system written for the Django framework.

django-nyt does this:

from django_nyt.utils 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 a cleverly sifted stream of events that’s highly customizable as well. By using django-nyt, your users can subscribe to global events or specific events pertaining specific objects.

Each event can be associated with a link so the user can use the notifications as shortcuts in their work flow.

What do you need to do?

You need to do a lot! But django-nyt does everything to meet as many needs as possible. 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:

Javascript drop-down: Some examples are provided in the docs, but there is no real easy way to place this nifty little thing at the top of your site, you’re gonna have to work it out on your own.

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