Skip to main content

Notification sytem for Django

Project description

Documentation Status

Django NotifyX is a reusable app which adds notification system features to your Django app.

It was inspired from django-notifications , major differences include:
  • Multipe user notification at once.

  • A different approch for notification updates.

  • Less hassles when trying to format notifications differently accoring to their types.

  • AJAX support for everything.

  • And many more.

This is just a quick guide to get things to work ASAP. To dive into the details.. Read the docs

How to install

Downloading the package

Probably the best way to install is by using PIP:

$ pip install django-notify-x

If you want to stay on the bleeding edge of the app:

$ git clone
$ cd django-notify-x
$ python install

Installing it on your project

After the you’ve installed django-notify-x in your python enviroment. You have to make an entry of the same in your project file:


Then an entry on the file:

urlpatterns = (
    url(r'^notifications/', include('notify.urls', 'notifications')),

Then run migrations:

$ python migrate notify

Then collectstatic to make sure you’ve copied the JS file for AJAX functionality:

$ python collectstatic

You’ve successfully installed django-notify-x!

Sending notifications

Sending notifications to single user

from notify.signals import notify

# your example view
def follow_user(request, user):
    user = User.objects.get(username=user)

    notify.send(request.user, recipient=user, actor=request.user
                verb='followed you.', nf_type='followed_by_one_user')

    return YourResponse

Easy as pie, isn’t it?

Sending notifications to to multiple users:

from notify.signals import notify

# your example view
def upload_video(request):
    video = VideoUploader.getupload()
    followers = list(request.user.followers())

    notify.send(request.user, recipient_list=followers, actor=request.user
                verb='uploaded.', target=video, nf_type='video_upload_from_following')

    return YourResponse

Just change the recipient to recipient_list and send notifications to as many users you want!

Notification Template tags

This app comes with two notification tags, one renders notifications for you and the other includes javascript variables and functions relating the notifyX.js file.


As its name reflects, it will render notifications for you. render_notifications will take at least one parameter and maximum two parameters.

You can use them to render notifications using a Notification QuerySet object, like this:

{% load notification_tags %}
{% render_notifications using %}

By default, the above tag will render notifications on the notifications page and not on the notification box. So it will use a template corresponing to it’s nf_type with a .htm suffix nothing more.

To render notificatons on a notifications box:

{% load notification_tags %}
{% render_notifications using for box %}

This tag will look for template name with _box.html suffixed when rendering notification contents.

The is just used to show an example of notification queryset, you can use any other way to supply a QuerySet of your choice.


This tag uses notifications/includes/js_variables.html to include a template populated with JS variables and functions. You can override the values of any JS variables by creating your own version of js_variables.html template.

To include JS variables for AJAX notification support, do this:

{% load notification_tags %}
{% if user.is_authenticated %}
    {% include_notify_js_variables %}
{% endif %}

This template inclusion includes three javascript files from the template includes directory, they are:


All of them are nothing but javascript function declarations which are supposed to run when a JQuery AJAX request is successfully completed.

And other things…

It will be best to Read the Docs instead of expecting every thing from a quick guide :)

Project details

Download files

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

Source Distribution

django-notify-x-0.1.tar.gz (19.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page