https://github.com/dcramer/django-notices
A message notification system for Django
https://github.com/dcramer/django-notices
Last synced: 4 months ago
JSON representation
A message notification system for Django
- Host: GitHub
- URL: https://github.com/dcramer/django-notices
- Owner: dcramer
- License: bsd-2-clause
- Created: 2009-08-23T20:22:07.000Z (almost 16 years ago)
- Default Branch: master
- Last Pushed: 2010-02-01T06:53:52.000Z (over 15 years ago)
- Last Synced: 2025-02-06T11:18:54.939Z (4 months ago)
- Language: Python
- Homepage:
- Size: 430 KB
- Stars: 22
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
django-notices
--------------
django-notices is a replacement for the built-in message notification system in Django. It works off of the current session rather than a database store, which means it also works for Anonymous users, and does not require doing database queries each time you need to access it.
Installation
============
To install the latest stable version::
sudo easy_install django-notices
To install the latest development version (updated quite often)::
git clone git://github.com/dcramer/django-notices.git
cd django_notices
sudo python setup.py install
Usage
=====
The easiest way to use django-notices, is simply by adding it to your settings.py::
INSTALLED_APPS = (
'...',
'django_notices',
)
MIDDLEWARE_CLASSES = (
'django_notices.middleware.NoticeMiddleware',
)
TEMPLATE_CONTEXT_PROCESSORS = (
'django_notices.context_processors.notices',
)
Once you've done this you'll now have access to two important pieces of the notice system, the ``notices`` context variable, and ``request.notices``.
The first thing you're going to want to do, is add a handler for ``notices`` within your templates::
{% for notice in request.notices %}
- {{ notice.message|escape }}
{% endfor %}
What this does, is on each page load, displays each active notice and clears it from the session.
Now once you can display your notices, you'll need to begin adding them. This is also made very ::
def my_view(request):
request.notices.warn('This is a warning')
There are several methods available in the built-in handler::
NoticeHandler.warn
NoticeHandler.error
NoticeHandler.info
NoticeHandler.debug
NoticeHandler.success
By default, DEBUG level notices are not shown. To change this, you can adjust the ``NOTICE_LEVEL`` setting in your ``settings.py``::
from django_notices import DEBUG
NOTICE_LEVEL = DEBUG