django-dans-notifications 1.0.4

A Django app to handle notifications.

Django Dans Notifications

GitHub

PyPi

Description

A Django app to handle notifications.

Support for basic notifications, push notifications and email notifications.

Quick start

1. Add "notifications" to your INSTALLED_APPS setting like this:

INSTALLED_APPS = [
	...
	'notifications',
]

2. Include the notifications URLconf in your project urls.py like this:

path("notifications/", include("notifications.urls")),

3. Run python manage.py migrate to create the models.

4. Create notifications via the API endpoints, in code or your Admin portal.

Requirements

• Python 3.0 or higher
• Django 3.0 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:

REST_FRAMEWORK = {
    "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
    "PAGE_SIZE": 20,
    "DEFAULT_AUTHENTICATION_CLASSES": (
        "rest_framework.authentication.TokenAuthentication",
    ),
}

Available Settings

• IN_TEST - Whether running in tests or not. Used to determine whether to actually send email.

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 a class to expose some common functionality and maintain object permissions.

Some available methods currently are:

• get_notifications_push/email/basic/all
  • Enforce object ownership and notification 'direction'
• mark_notification_basic_read

Models

See Model docs.

APIs

See API docs.

Email Templates

See Email Template docs.