A Django app to handle basic notifications.
Project description
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.
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_dans_notifications-1.3.1.tar.gz.
File metadata
- Download URL: django_dans_notifications-1.3.1.tar.gz
- Upload date:
- Size: 37.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d4ad6ce2e62c14e9e61c5e9c7b53c9d92234fa23f4dbbe658cdab11675816a7a
|
|
| MD5 |
dd54179b6e39952e54a5602ff44b2746
|
|
| BLAKE2b-256 |
055b9f775836d78d64fd70d7047ff9bf9b4280640461c8123aafe235a40902f6
|
File details
Details for the file django_dans_notifications-1.3.1-py3-none-any.whl.
File metadata
- Download URL: django_dans_notifications-1.3.1-py3-none-any.whl
- Upload date:
- Size: 49.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2f7947d4865a07de77fb2d395b84a016fed47299bc228c3ff061f6198e866e76
|
|
| MD5 |
61dd8ea6a48381edcdd1e7f63635247c
|
|
| BLAKE2b-256 |
01c9d0059ea06bf27fd59b00bf56357bf001774eb9b59dbfac03b966d95f5a2d
|
