Django app for sending notifications.
Project description
django-ilmoitin
A templated Django messaging library
Installation
-
pip install django-ilmoitin
-
Add
django_ilmoitin
toINSTALLED_APPS
.
Usage
django-ilmoitin
usesdjango-mailer
to send emails, so you need to configure theMAILER_EMAIL_BACKEND
setting to letdjango-mailer
know, how to actually send the mail:
MAILER_EMAIL_BACKEND = "your.actual.EmailBackend"
- Create a
notifications.py
file in django app and register your notification types:
from django_ilmoitin.registry import notifications
notifications.register("event_created", "Event created")
- Create a
dummy_context.py
file in django app and add dummy context data:
from django_ilmoitin.dummy_context import dummy_context
from .models import MyModel
model = MyModel(foo="bar")
dummy_context.context.update({
"model": model
})
- Import notifications and dummy context in your apps.py:
from django.apps import AppConfig
class ExampleConfig(AppConfig):
name = "example"
def __init__(self, *args, **kwargs):
super(ExampleConfig, self).__init__(*args, **kwargs)
import example.notifications
def ready(self):
import example.dummy_context
-
Go to django admin and add notification templates to your notifications
-
Send notifications:
from django_ilmoitin.utils import send_notification
context = {
"foo": "bar",
}
send_notification("foo@bar.com", "event_created", context)
Code format
This project uses black
for Python code formatting.
We follow the basic config, without any modifications. Basic black
commands:
- To let
black
do its magic:black .
- To see which files
black
would change:black --check .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django_ilmoitin-0.1.2.tar.gz
(8.6 kB
view hashes)
Built Distribution
Close
Hashes for django_ilmoitin-0.1.2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f203a677175e8c6032e20afbe884be7eaa91f9f3d1537c7c439429ddbe1b4959 |
|
MD5 | abbcd3e15951e9caf25d739553f41415 |
|
BLAKE2b-256 | 7b3971fb42aa10fdced555287f8e08503c08df85c90dbcafeb878ec021dfe491 |