Skip to content

amanjain/django-notifier

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

django-notifier

Send notifications (Email, SMS etc) and manage preferences and permissions per user and group.

See full documentation at http://django-notifier.rtfd.org/

To register a notification:

create_notification('test-notification')

To send notifications:

send_notification('test-notification', [user1, user2, ..])

Installation

Install via pip:

$ pip install django-notifier

Setup

  1. Add notifier to INSTALLED_APPS in your django settings file.

    INSTALLED_APPS = (
        ...
        'notifier',
        ...
    )
    
  2. Settings

    If you are going to use any custom backends to send notifications, add the setting NOTIFIER_BACKENDS to your settings file. If this setting is not defined, only the EmailBackend is used by default.

    NOTIFIER_BACKENDS = (
        'notifier.backends.EmailBackend',
        'path.to.custom.backend.CustomBackend',
    )
    
  3. Run syncdb or migrate (if using South) to create the necessary tables in the database.

    $ python manage.py syndb
    

    If using South:

    $ python manage.py migrate
    
  4. Create a Notification Preferences for the User/Group before trying to send a notification. Notifications don't work if preferances are not set.

About

Send notifications (Email, SMS etc) and manage preferences and permissions per user and group.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Python 100.0%