Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dan1229/django_dans_notifications
A Django app to help handle and manage notifications via basic models, APIs and helper functions
https://github.com/dan1229/django_dans_notifications
django python
Last synced: about 2 months ago
JSON representation
A Django app to help handle and manage notifications via basic models, APIs and helper functions
- Host: GitHub
- URL: https://github.com/dan1229/django_dans_notifications
- Owner: dan1229
- License: bsd-3-clause
- Created: 2022-05-28T05:14:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T03:00:40.000Z (9 months ago)
- Last Synced: 2024-04-25T04:22:23.232Z (9 months ago)
- Topics: django, python
- Language: Python
- Homepage: https://pypi.org/project/django-dans-notifications/
- Size: 219 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Django Dans Notifications
[](https://github.com/dan1229/django_dans_notifications/actions/workflows/python-lint.yml)
[](https://github.com/dan1229/django_dans_notifications/actions/workflows/python-test.yml)
[](https://github.com/dan1229/django_dans_notifications/actions/workflows/python-types.yml)
[](https://codecov.io/gh/dan1229/django_dans_notifications)
[](https://www.python.org/)
[](https://www.djangoproject.com/)
[](https://pypi.org/project/django-dans-notifications/)
[](https://pepy.tech/project/django-dans-notifications)
[](https://github.com/dan1229/django-dans-notifications/blob/main/LICENSE.txt)
[](https://www.codacy.com/app/dan1229/django-dans-notifications)
[](https://github.com/psf/black)
## Description
A Django app to handle notifications.
Support for basic notifications, push notifications, and email notifications.
[Available on PyPi](https://pypi.org/project/django-dans-notifications/)
## Quick start
1. Install the package via pip:
```bash
pip install django-dans-notifications
```
2. Add "django_dans_notifications" to your INSTALLED_APPS setting like this:
```python
INSTALLED_APPS = [
...
'django_dans_notifications',
]
```
3. Include the URL configs in your project `urls.py` for the REST API endpoints like this:
```python
path("api/notifications/", include("django_dans_notifications.urls")),
```
4. Run `python manage.py migrate` to update your database schema.
5. Use the API endpoints, in code or your Django admin portal.
### Requirements
- Python 3.8 or higher
- Django 3.1 or higher
- Django Rest Framework
- **NOTE:** not only must you have this installed, you must have set `DEFAULT_AUTHENTICATION_CLASSES` and `DEFAULT_PAGINATION_CLASS` in your `settings.py` to work with the APIs properly. An example config would be:
```python
REST_FRAMEWORK = {
"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
"PAGE_SIZE": 20,
"DEFAULT_AUTHENTICATION_CLASSES": (
"rest_framework.authentication.TokenAuthentication",
),
}
```
### Available Settings
Currently all available settings are optional:
- `TEAM_NAME` - Default team name to use for emails, can be added to message context manually as well still.
- `IN_TEST` - Whether running in tests or not. Used to determine whether to actually send email.
Add these to your `settings.py` file to customize the app's behavior like so:
```python
TEAM_NAME = "My Team"
IN_TEST = True
```
## 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`.
## Usage
The main way to interact with this app is to create and use the appropriate models and their managers' methods as needed.
Also included is the `NotificationManager` class to expose some common functionality and maintain object permissions.
Some of its methods currently are:
- `get_notifications_push/email/basic/all`
- Enforce object ownership and notification 'direction'
- `mark_notification_basic_read`
You can also interact directly, so for example to send an email notification:
```python
from django_dans_notifications.models.notifications import NotificationEmail
email_notification = NotificationEmail.objects.send_email(
subject="Hello",
template="django-dans-emails/default.html",
sender="[email protected]",
recipients=["[email protected]"],
context={"user": "John Doe"},
file_attachment=None
)
```
## Docs
#### [Model docs](https://github.com/dan1229/django_dans_notifications/tree/main/docs/models.md).
#### [API docs](https://github.com/dan1229/django_dans_notifications/tree/main/docs/apis.md).
#### [Email Template docs](https://github.com/dan1229/django_dans_notifications/tree/main/docs/email-templates.md).
-------------------------------------------------------
##### [https://danielnazarian.com](https://danielnazarian.com)
##### Copyright 2024 © Daniel Nazarian.