Django Dans Notifications
Description
A Django app to handle notifications.
Support for basic notifications, push notifications, and email notifications.
Quick Start
pip install django-dans-notifications
See the Getting Started Guide for detailed installation and configuration instructions.
Requirements
- Python 3.8 or higher
- Django 3.1 or higher
- Django Rest Framework (with authentication configured)
Basic Usage
from django_dans_notifications.models.notifications import NotificationEmail
# Send an email notification
notification = NotificationEmail.objects.send_email(
subject="Welcome",
template="django-dans-emails/default.html",
sender="noreply@example.com",
recipients=["user@example.com"],
context={"team_name": "My Team"}
)
See the Usage Guide for more examples and advanced usage.
Features
Models
- NotificationEmail: Handles email notifications.
- NotificationBasic: Handles basic notifications.
- NotificationPush: Handles push notifications.
Managers
- NotificationEmailManager: Handles sending and managing email notifications.
- NotificationBasicManager: Handles basic notifications.
- NotificationPushManager: Handles push notifications.
API ViewSets
- NotificationEmailViewSet: API endpoints for email notifications.
- NotificationBasicViewSet: API endpoints for basic notifications.
- NotificationPushViewSet: API endpoints for push notifications.
Utility Classes
- NotificationManager: Exposes common functionality and maintains object permissions.
- Methods:
get_notifications_push/email/basic/all,mark_notification_basic_read.
- Methods:
Documentation
- Getting Started - Installation and configuration
- Usage Guide - How to send notifications and use the app
- API Documentation - REST API endpoints reference
- Model Documentation - Detailed model information
- Email Templates - Template system and customization
Support
For issues, questions, or contributions, please visit the GitHub repository.
https://danielnazarian.com
Copyright 2024 © Daniel Nazarian.
1 maintainer
Release files for django-dans-notifications 1.4.0
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_dans_notifications-1.4.0.tar.gz | 38.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_dans_notifications-1.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 89.2 kB
Release files / django_dans_notifications-1.4.0.tar.gz
| Download URL | django_dans_notifications-1.4.0.tar.gz |
|---|---|
| Size | 38.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
28e19718af8950ecfd154a581f517d4be50a84d8dcd8c36018a32c561b283fff
|
|
BLAKE2b-256 checksum How to use checksums |
b340aae24542dda8e046b2fd0428b75cd4417f49716ce29979e3290bab0add1f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / django_dans_notifications-1.4.0-py3-none-any.whl
| Download URL | django_dans_notifications-1.4.0-py3-none-any.whl |
|---|---|
| Size | 50.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ccd10d62597f21c938a117fcac2856c412853e97a55be3521f86f55d4b3d1989
|
|
BLAKE2b-256 checksum How to use checksums |
e169c3adacbd5382f2f4edeea40182cd0815f7de332974220251489dbf5aaf49
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
