A simple Django app to support Notifications.
Project description
=============== Notifications
Notifications is a simple Django app to serve notifications to your users.
To start:
pip install trackwell-notifications
=============== Aknowledgements
The push notification functionality comes from the great work made by the contributers to the fcm-django module, which is subject to an MIT license.
We would've used it straight as a dependency, but it kind of clashed with other functionality of our setup, such as our multi-tenancy and other things, so we had to add the source code directly with a bit of our own modifications.
We do not claim to have written said code (even if we might modify it to our needs) and have added attribution and links in the imported code.
Quick start
-
pip install trackwell-notifications
-
Add "notifications" to your INSTALLED_APPS setting like this::
INSTALLED_APPS = [ ... 'notifications', ]
Make sure it is after the auth etc.::
MIDDLEWARE_CLASSES = (
...
'notifications.middleware.NotificationMiddleware',
)
-
Put the js and css imports in your base template where you want things to pop up
<script type="text/javascript" src="{% static "notifications/Notifications.js" %}"></script> <link rel="stylesheet" href="{% static "css/notifications.css" %}" type="text/css" />
And also add in a script tag where the location of your notifications endpoint is:
window.notificationEndpoint = '/api/usernotifications/'; // Don't forget trailing slash
-
Include the polls URLconf in your project urls.py like this::
path('notifications/', include('notifications.urls')),
-
Register the api
from notifications.api.views import NotificationViewSet from notifications.api.views import UserNotificationViewSet
router.register(r'users', UserViewSet) router.register(r'^users_in_groups', UsersInGroupsViewSet, 'Users in groups')
-
Run
python manage.py migrate
to create the notifications models. -
Start the development server and visit http://127.0.0.1:8000/admin/notifications
Project details
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
Hashes for trackwell-notifications-4.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 569e8adc5f7404d5b4a36c96cc83fe62a9f0730dacfb4a56d2aeae87cd9f5e32 |
|
MD5 | 42f6891dca0e07a300c22e12cf49a5e2 |
|
BLAKE2b-256 | 99047d22bb50c1ccbe84573218e010b06742a2394ece5b835c9db48e5c26eef6 |
Hashes for trackwell_notifications-4.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84437b66318b5b14c2a711498f9a4f9c98d61630e3d201e8039e18a8042b9e7b |
|
MD5 | 63def80b8b146844b23208fc8c1022c3 |
|
BLAKE2b-256 | c5b2b8667f0f70adacb65047a2fe1fea1877c9bfe1b1d3bb9836f67c055525ee |