Django message notification package
Project description
Django user notification
Overview
Django user notification is intended to provide a way to send multiple types of notification messages to django users out of box and docs are on the way...
Requirements
- Python (3.8, 3.9, 3.10)
- Django (3.1, 3.2, 4.0, 4.1)
We highly recommend and only officially support the latest patch release of each Python and Django series.
Installation
Install using pip
...
pip install django-user-notification
Add 'notification'
to your INSTALLED_APPS
setting.
INSTALLED_APPS = [
...
'notification',
]
Quick Start
Let's take a look at a quick start of using Django user notification to send notification messages to users.
Run the notification
migrations using:
python manage.py migrate notification
Add the following to your settings.py
module:
INSTALLED_APPS = [
... # Make sure to include the default installed apps here.
'notification',
]
DJANGO_USER_NOTIFICATION = {
"aliyunsms": {
"access_key_id": "ACCESS_KEY_ID",
"access_key_secret": "ACCESS_KEY_SECRET",
"sign_name": "SIGN_NAME",
},
"dingtalkchatbot": {
"webhook": "DINGTALK_WEBHOOK",
},
"dingtalkworkmessage": {
"agent_id": "DINGTALK_AGENT_ID",
"app_key": "DINGTALK_APP_KEY",
"app_secret": "DINGTALK_APP_SECRET",
},
"dingtalktodotask": {
"app_key": "DINGTALK_APP_KEY",
"app_secret": "DINGTALK_APP_SECRET",
},
}
Let's send a notification
from django.contrib.auth import get_user_model
from notification.backends import notify_by_email, notify_by_dingtalk_workmessage
User = get_user_model()
recipient = User.objects.first()
# send a dingtalk work message notification
notify_by_dingtalk_workmessage([recipient], phone_field="phone", title="This is a title", message="A test message")
# send a email notiofication
notify_by_email([recipient], title="This is a title", message="A test message")
Send Message With Template
django-user-notification
support send notifications with custom template, To
specify a custom message template you can provide the template_code
and context
parameters.
-
Create a template message with code named
TMP01
on django admin -
Provide the
template_code
andcontext
tosend
method:
...
notify_by_email([recipient], template_code="TMP01", context={"content": "Hello"})
Supported backends
DummyNotificationBackend
: send dummy messageEmailNotificationBackend
: send email notification.WebsocketNotificationBackend
: send webdocket notification, needchannels
installedAliyunSMSNotificationBackend
: send aliyun sms notification.DingTalkChatBotNotificationBackend
: send dingtalk chatbot notification.DingTalkTODOTaskNotificationBackend
: send dingtalk todo tasks notificationDingTalkWorkMessageNotificationBackend
: send dingtalk work message notification.
Running the tests
To run the tests against the current environment:
$ ./manage.py test
Changelog
0.5.0
- Initial release
Thanks
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 django-user-notification-0.7.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee97139cd1b408e039bea6e77a006e16bf23820a933938fadeddd8a206ab95ef |
|
MD5 | 2ae01b78c07b7505bbbc3acc8dd9d3cb |
|
BLAKE2b-256 | 66e0123eb909406165790671af3b5f9260a3d438669f9236e62b1dcdceeac8cc |
Hashes for django_user_notification-0.7.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3ac9fa7be19f47840e4e5a92a6931ae82724ea633868bd5ea3a74e08b103f5f |
|
MD5 | 32bdd1b498a33a8bfd88823bd42d80cd |
|
BLAKE2b-256 | 176fe39f775944a2d16f9f899fcd9426a755d80ea8274eeb24f2e6229ea476fa |