[](https://travis-ci.org/jiaaro/django-alert)
## Installation ##
1. Install lib with pip:
`pip install django-alert`
**- OR -**
Put the "alert" directory somewhere in your python path
2. Add "alert" to your installed apps (in the settings.py file)
3. Also add "django.contrib.sites" in installed apps in case it's not there.
4. Run ./manage.py migrate
## Making Alerts ##
Create an "alerts.py" file and import it at the bottom of your
models.py file. This is where you will define your alert class. Every
alert is subclassed from "alert.utils.BaseAlert"
Here is an example alert that is sent to users when they first sign up:
from django.contrib.auth.models import User
from django.db.models.signals import post_save
from alert.utils import BaseAlert
class WelcomeAlert(BaseAlert):
title = 'Welcome new users'
description = 'When a new user signs up, send them a welcome email'
signal = post_save
sender = User
default = False
def before(self, created, **kwargs):
return created
def get_applicable_users(self, instance, **kwargs):
return [instance]
## Writing Alert Backends ##
Alert includes an Email Backend by default. But you can write a backend
for *any* messaging medium!
Alert Backends just need to subclass BaseAlertBackend and implement a
`send()` method that accepts an alert instance
You can copy and paste the following code to get started:
from alert.utils import BaseAlertBackend
class MyAlertBackend(BaseAlertBackend):
def send()
## Signals ##
When an alert is sent, a signal is fired (found in alert.signals). The
"sender" keyword argument is the Alert you defined (WelcomeAlert in
this case).
example:
from alert.signals import alert_sent
def do_something_after_welcome_alert_is_sent(sender, alert, **kwargs):
pass
alert_sent.connect(do_something_after_welcome_alert_is_sent,
sender=WelcomeAlert)
## Installation ##
1. Install lib with pip:
`pip install django-alert`
**- OR -**
Put the "alert" directory somewhere in your python path
2. Add "alert" to your installed apps (in the settings.py file)
3. Also add "django.contrib.sites" in installed apps in case it's not there.
4. Run ./manage.py migrate
## Making Alerts ##
Create an "alerts.py" file and import it at the bottom of your
models.py file. This is where you will define your alert class. Every
alert is subclassed from "alert.utils.BaseAlert"
Here is an example alert that is sent to users when they first sign up:
from django.contrib.auth.models import User
from django.db.models.signals import post_save
from alert.utils import BaseAlert
class WelcomeAlert(BaseAlert):
title = 'Welcome new users'
description = 'When a new user signs up, send them a welcome email'
signal = post_save
sender = User
default = False
def before(self, created, **kwargs):
return created
def get_applicable_users(self, instance, **kwargs):
return [instance]
## Writing Alert Backends ##
Alert includes an Email Backend by default. But you can write a backend
for *any* messaging medium!
Alert Backends just need to subclass BaseAlertBackend and implement a
`send()` method that accepts an alert instance
You can copy and paste the following code to get started:
from alert.utils import BaseAlertBackend
class MyAlertBackend(BaseAlertBackend):
def send()
## Signals ##
When an alert is sent, a signal is fired (found in alert.signals). The
"sender" keyword argument is the Alert you defined (WelcomeAlert in
this case).
example:
from alert.signals import alert_sent
def do_something_after_welcome_alert_is_sent(sender, alert, **kwargs):
pass
alert_sent.connect(do_something_after_welcome_alert_is_sent,
sender=WelcomeAlert)
1 maintainer
Metadata
1 maintainer
Release files for django-alert 0.8.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django-alert-0.8.1.tar.gz | 13.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_alert-0.8.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 37.7 kB
Release files / django-alert-0.8.1.tar.gz
| Download URL | django-alert-0.8.1.tar.gz |
|---|---|
| Size | 13.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
30c065f0d66a78698871c723f6348a329ad52593c8cc096b2afcef04114e8f41
|
|
BLAKE2b-256 checksum How to use checksums |
e8722b26dd04220d5ac63b09557e28fe0b89613f35dcc0f9515c6e5e841d9b97
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / django_alert-0.8.1-py2.py3-none-any.whl
| Download URL | django_alert-0.8.1-py2.py3-none-any.whl |
|---|---|
| Size | 23.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
a1f2f9afc0324c44dfa5c171752597f13f07efae68cb7c120be044183bc0914e
|
|
BLAKE2b-256 checksum How to use checksums |
0aee4c666679caf2bf2b9f8425e373fe7e4d12ab1d29893fc676bea16b64001d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
