django-delayed-notifications provides tracking of notifications, and delayed sending.
Project description
Notifications
This application sends notifications to the user and emails addresses. It stores messages into a database, and sends can be delayed through a cron task.
Installation
$ pip install django-delayed-notifications
Add django_notifications to your INSTALLED_APPS:
INSTALLED_APPS = (
...
"django_notifications",
...
)
Apply the migrations:
$ ./manage.py migrate
Usage
Instead of sending a raw email, with the send_mail django function, you can create a Notification object and program
the sending.
Notification creation
from pathlib import Path
from django_notifications.models import Notification, Attachment
from django.core.files import File
from django.utils.timezone import now
from datetime import timedelta
# **Basic creation**
my_instance = "<A random object in the application>"
notification = Notification.objects.create(
subject="My beautiful email",
text_body="My text body",
html_body="""<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="x-apple-disable-message-reformatting">
<title>My beautiful email</title>
</head>
<body>My HTML body</body>
</html>
""",
from_email="foo@example.org", # Optional
related_object=my_instance, # Optional
)
# ** Related objects states management **
# When using FSM, you can provide the states from / to (Optional)
notification.state_from = "active"
notification.state_to = "processing"
# **Attachments management**
# Include file from a raw file
from django.core.files.base import ContentFile
_attachment = Attachment.objects.create(
notification=notification,
attachment_file=ContentFile(Path("<my_file>").open("r"), name="my_file.txt")
)
# Including an attachment from a FileField
from django.db.models.fields import FieldFile
assert isinstance(my_instance.file, FieldFile)
_attachment = Attachment.objects.create(
notification=notification,
attachment_file=ContentFile(my_instance.file.read(), name=my_instance.file.name)
)
# **Recipients management**
# You can provide users
notification.recipients.set("<User instance>", "<User instance>", ...)
# And / Or provides email address, `\n` separated
notification.email_recipients = "\n".join([
"foo@example.org", "bar@example.org"
])
notification.save()
# You can set the delayed sending date
notification.delayed_sending_at = now() + timedelta(days=1)
notification.save()
# Or you can send the email immediately
notification.send()
Management command
Send notifications
This command can be used in a cron, to provide delayed sending.
$ ./manage.py send_notifications --help
usage: manage.py send_notifications [-h] [--version] [-v {0,1,2,3}] [--settings SETTINGS] [--pythonpath PYTHONPATH] [--traceback] [--no-color] [--force-color] [--skip-checks]
options:
-h, --help show this help message and exit
--version Show program's version number and exit.
-v {0,1,2,3}, --verbosity {0,1,2,3}
Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output
--settings SETTINGS The Python path to a settings module, e.g. "myproject.settings.main". If this isn't provided, the DJANGO_SETTINGS_MODULE environment variable will be used.
--pythonpath PYTHONPATH
A directory to add to the Python path, e.g. "/home/djangoprojects/myproject".
--traceback Display a full stack trace on CommandError exceptions.
--no-color Don't colorize the command output.
--force-color Force colorization of the command output.
--skip-checks Skip system checks.
$ ./manage.py send_notifications
12 notifications sent.
Clean notifications
It's possible to clean attachments and notification (files are removed for storage too)
$ ./manage.py clean_notifications --help
usage: manage.py clean_notifications [-h] [--dry-run] [--days DAYS] [--version] [-v {0,1,2,3}] [--settings SETTINGS] [--pythonpath PYTHONPATH] [--traceback] [--no-color] [--force-color] [--skip-checks]
Remove older notifications.
options:
-h, --help show this help message and exit
--dry-run, -n Do not perform deletions
--days DAYS, -d DAYS Delete notifications older already sent since <days> days.
--version Show program's version number and exit.
-v {0,1,2,3}, --verbosity {0,1,2,3}
Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output
--settings SETTINGS The Python path to a settings module, e.g. "myproject.settings.main". If this isn't provided, the DJANGO_SETTINGS_MODULE environment variable will be used.
--pythonpath PYTHONPATH
A directory to add to the Python path, e.g. "/home/djangoprojects/myproject".
--traceback Display a full stack trace on CommandError exceptions.
--no-color Don't colorize the command output.
--force-color Force colorization of the command output.
--skip-checks Skip system checks.
$ ./manage.py clean_notifications -d 30
20 notifications and 10 attachments are about to be deleted.
20 notifications and 10 attachments are DELETED.
Templates
The application provides some basic templates for emails, and provides some basic blocks.
Provided blocks
{% extends "django_notifications/base_email.html" %
{% block extrahead %}<!-- JS / CSS to add to header -->{% endblock extrahead %}
{% block header %}<!-- Email header (empty) -->{% endblock header %}
{% block page_title %}
{% block title-content %}{{ subject }}{% endblock title-content %}
{% endblock page_title %}
{% block main-content %}<!-- Main content on the email -->{% endblock main-content %}
{% block buttons %}
<div class="buttons">
{% block buttons-content %}<!-- Link buttons -->{% endblock buttons-content %}
</div>
{% endblock buttons %}
{% block signature %}
<div class="signature">
{% block signature-content %}<!-- Email signature content -->{% endblock signature-content %}
</div>
{% endblock signature %}
Config
This application provides an admin interface for notifications.
- delay_notifications: Delay notification sending, using the cron job
- delay: Delay to apply to notifications
- receive_notifications_field: Name of the field to allow notification send
- receive_messages_field: Name of the field to allow notification send -- NOT USED
- enable_debug_notifications: Enable (re)sending emails
- debug_notifications_email: Target recipient of the email debugging
Notes
The application is available in English and translated to French.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_delayed_notifications-0.12.3.tar.gz.
File metadata
- Download URL: django_delayed_notifications-0.12.3.tar.gz
- Upload date:
- Size: 5.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b05390401d4eb71bfcb47dea6203355fdcf3ac88d50aaf269c42847a65c14e11
|
|
| MD5 |
be8c9a5669d16e5198f23e0bcc251c42
|
|
| BLAKE2b-256 |
16813f0140c8bbdb6ae406d904c037c37fb9180c7fef0b54a6779c0b0cef16d5
|
File details
Details for the file django_delayed_notifications-0.12.3-py3-none-any.whl.
File metadata
- Download URL: django_delayed_notifications-0.12.3-py3-none-any.whl
- Upload date:
- Size: 36.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a0ce1e41f1099a50d7d147614597f5045825e00c4a821589cea57c6975aa484a
|
|
| MD5 |
15e9edc2e6c35f29adc9e676b4def8ee
|
|
| BLAKE2b-256 |
f3cd672f70bd5261e6af1c89ec1224f935805c0426471fcb24fb810feb62d90a
|
