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.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_dans_notifications-1.4.1.tar.gz | 39.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_dans_notifications-1.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 90.5 kB
Release files / django_dans_notifications-1.4.1.tar.gz
| Download URL | django_dans_notifications-1.4.1.tar.gz |
|---|---|
| Size | 39.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d3ddafcd37d2fe33b1cfea7a6ab615b746d98b6c11c6636e262b351ec3f3bfd3
|
|
BLAKE2b-256 checksum How to use checksums |
4b2d1cfebb388b95d894020ef2ab789f684059cca124dc064c0617fa36fc5708
|
| 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.1-py3-none-any.whl
| Download URL | django_dans_notifications-1.4.1-py3-none-any.whl |
|---|---|
| Size | 51.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3fa0e8b014fe02915dce117cba3bc01d33f4799fe515b6cd67c2606b822ff115
|
|
BLAKE2b-256 checksum How to use checksums |
9b234fd75091a146c9982251aad3e8159bd1ce56cdc85af283e0925964a73427
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
