0.1.2: December 1, 2011

- The DjangoMessagesNotificationBackend can now use the subject as well as the text
- Easier to subclass BaseNotification and set your own default properties
- Changed documentation to reStructuredText, in preparation of move to PyPi

Author: Kevin Renskers

CHANGELOG

@@ -0,0 +1,10 @@
+0.1.0: Never published
+- Initial version
+
+0.1.1: Never published
+- Bugfixes
+
+0.1.2: December 1, 2011
+- The DjangoMessagesNotificationBackend can now use the subject as well as the text
+- Easier to subclass BaseNotification and set your own default properties
+- Changed documentation to reStructuredText, in preparation of move to PyPi

INSTALL

@@ -0,0 +1,6 @@
+Install
+=======
+
+1. Get the code: ``pip install django-generic-notifications``
+2. Add 'notifications' to your INSTALLED_APPS
+3. Sync the database (south migrations are provided)

INSTALL.rst

@@ -1,2 +1,6 @@
 include AUTHORS
 include LICENSE
+include CHANGELOG
+include INSTALL.rst
+include README.rst
+include USAGE.rst

MANIFEST.in

@@ -0,0 +1,67 @@
+========
+Overview
+========
+
+**A Django app that can handle multiple ways of showing different notification types. It's all based on multiple input
+types and output backends.**
+
+
+Notifications
+=============
+A notification could be anything:
+
+- there was an error in your form submission
+- your account has been created
+- your account has been activated
+- you have received a private message on a forum
+- there is a new comment on your blog
+- someone liked your profile
+- a message from the administrator
+
+As far as this project is concerned, a notification is nothing more but an (optional) subject, text body, and a level
+(info, success, error, warning).
+
+Backends
+========
+There are multiple output backends. Some possible examples are:
+
+- email
+- a popup in your webbrowser
+- sms message
+- iPhone push notification
+- Django's messages app
+
+Some backends can process notifications in real time (Django's messages app for example), and others should run in the
+background (sending email, sending push messages to iPhones). Each backend specifies what its mode of operation is.
+
+Notification types
+==================
+A notification type is the glue between a message (input) and one or more possible backends (output). For example, you
+might want to send all account related messages to email only, but notifications about new private messages could go to
+email, iPhone push messages, Django's own messages app, you name it.
+
+Each notification type can specify its allowed backend, and each user can specify his preferred output backend(s).
+Each notification will then figure out what backend to use based on this information.
+
+Settings
+========
+Some backends will need extra information from the user, for example a phone number, email address or iPhone device id.
+
+This project doesn't provide a settings app where users can configure these. Instead, this is left to an exercise to the
+reader (at least for now). Each output backend can accept a variable number of keyword arguments, so building a custom
+backend that needs a new setting isn't a problem.
+
+Queue
+=====
+Some notification backends can't process in real time, instead adding them to a queue. At this moment, this is based on
+a simple database model and a manage.py script which can be used from your cron.
+
+In the future celery tasks should be added too.
+
+Installation
+============
+See `INSTALL.rst`
+
+Usage
+=====
+See `USAGE.rst` for examples

README.md

@@ -1,5 +1,6 @@
-# Usage
-Simple example of use cases:
+Usage
+=====
+Simple example of use cases::
 
     from notifications.type.default import DefaultNotification
     DefaultNotification('Subject', 'This is a notification!', request=request).do('add')
@@ -8,8 +9,10 @@ Simple example of use cases:
     AccountNotification('Account created', 'Your account has been created!', user=request.user).do('add')
     AccountNotification('Account created', 'Your account has been created!', email='hello@example.com').do('add')
 
-## Cron
-There is a command to process notifications that have been added to the queue:
+
+Cron
+====
+There is a command to process notifications that have been added to the queue::
 
     ./manage.py process_notifications
 

README.rst

@@ -1 +1 @@
-__version__ = '0.1.1'
+__version__ = '0.1.2'

Usage.md renamed to USAGE.rst

@@ -31,6 +31,8 @@ def validate(self):
                 return False
             raise BackendConfigError('You need to add django.contrib.messages.context_processors.messages to TEMPLATE_CONTEXT_PROCESSORS')
 
+        self.text = self.notification.text or self.notification.subject
+
         return True
 
     def process(self):
@@ -44,4 +46,4 @@ def process(self):
 
         level = levels.get(self.notification.level, messages.INFO)
 
-        return messages.add_message(self.notification.request, level, self.notification.text)
+        return messages.add_message(self.notification.request, level, self.text)

notifications/__init__.py

@@ -16,7 +16,7 @@ class NotificationQueue(models.Model):
     """
     user = models.ForeignKey(User, blank=True, null=True, related_name='notifications')
     subject = models.CharField(max_length=255, blank=True)
-    text = models.TextField()
+    text = models.TextField(blank=True)
     level = models.CharField(max_length=40)
     extra_context = JSONField()
     tries = models.PositiveIntegerField(default=0)