Django app for sending notifications.
Project description
django-ilmoitin
A templated Django messaging library
Installation
-
pip install django-ilmoitin
-
Add
django_ilmoitin
toINSTALLED_APPS
. -
Run migrations
python manage.py migrate ilmoitin
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"
-
Define default from address in settings
DEFAULT_FROM_EMAIL = "your.email@address"
-
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") notifications.register("event_deleted", "Event deleted")
-
Create a
dummy_context.py
file in django app and add dummy context data. Either use the codes of notifications that you registered in the previous step, or use the constCOMMON_CONTEXT
to make some variables available for all templates:from django_ilmoitin.dummy_context import COMMON_CONTEXT, dummy_context from .models import MyModel my_object = MyModel(foo="bar") dummy_context.update({ COMMON_CONTEXT: {"my_object": my_object}, "event_created": { "foo": "bar" }, "event_deleted": { "fizz": "buzz" } })
-
Import notifications and dummy context in your apps.py:
from django.apps import AppConfig class ExampleConfig(AppConfig): name = "example" def ready(self): import example.notifications 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
Built Distribution
Hashes for django_ilmoitin-0.2.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd554dfd930ee58ad0bd32fc49aede3fe6f72aa08bbbd96a8a3d08f5a61614ee |
|
MD5 | 1ef51919a7ba20e6923f7c1ea5bbbc75 |
|
BLAKE2b-256 | 974a03a68c6be63039a1dd0f925c51cec78a0a3afb8328a8a567bfa1e3b72b6e |