.. image:: https://travis-ci.org/benjaoming/django-nyt.png?branch=master :target: https://travis-ci.org/benjaoming/django-nyt .. image:: https://readthedocs.org/projects/django-nyt/badge/?version=latest :target: http://django-nyt.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status .. image:: https://badge.fury.io/py/django-nyt.svg :target: https://pypi.python.org/pypi/django-nyt .. image:: https://coveralls.io/repos/github/benjaoming/django-nyt/badge.svg?branch=master :target: https://coveralls.io/github/benjaoming/django-nyt?branch=master
django-nyt is a notification framework for Django, it does this:
.. code:: python
from django_nyt.utils import notify EVENT_KEY = "my_key" notify(_("OMG! Something happened"), EVENT_KEY)
All users subscribing to
"my_key" will have a notification created
in their stack when
notify() is called.
If you have emails enabled, subscribers receive a summary of notifications at an interval of their choice.
Data can be accessed easily from Django models or from the included JSON views.
Starting from django-nyt 1.0, support for the upcoming
channels <http://channels.readthedocs.io/>_ has been added together with
Django 1.9 and 1.10 support.
In order to install the prerelease, use an extra flag for pip:
.. code:: bash
pip install django-nyt --pre
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.
Instead of inventing your own notification system, use this and you won’t have to design your own models, and you will have a nice guide that goes through the various steps of implementing notifications for your project.
Let’s try to summarize the reasons you want to be using django-nyt:
- Simple API: call
notify()where-ever you want.
- CLI for sending emails (as cron job, daemon or Celery task)
- Support for django-channels and Web Sockets (optional, fallback for JSON-based polling)
- Individual subscription settings for each type of event, for instance:
- Event type A spawns instant email notifications, but Event B only gets emailed weekly.
- Customizable intervals for which users can receive notifications
- Optional URL for action target for each notification
- Avoid clutter: Notifications don’t get repeated, instead a counter is incremented.
This project exists with
django.contrib.messages in mind, to serve a simple,
best-practice, scalable solution for notifications. There are loads of other
notification apps for Django, some focus on integration of specific communication
What do you need to do?
django-nyt does everything it can to meet as many needs as possible and have sane defaults.
Something like this:
Other items for your TODO list:
- Provide your users with options to customize their subscriptions and
notification preferences. Create your own
- Customize contents of notification emails by overwriting templates in
- Make the mail notification daemon script run either constantly
python manage.py notifymail --daemonor with some interval by invoking
python manage.py notifymail --cronas a cronjob. You can also call it from a Celery task or similar with
Development / demo project
In your Git fork, run
pip install -r requirements.txt to install the
The folder test-project/ contains a pre-configured django project and an SQlite database. Login for django admin is admin:admin::
cd test-project python manage.py runserver
After this, navigate to
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.