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.
Documentation
on the way...
Requirements
- Python 3.8, 3.9, 3.10
- Django 3.1, 3.2, 4.0, 4.1
Installation
Install using pip
...
pip install django-user-notification
Add 'django_quill'
and 'notification'
to your INSTALLED_APPS
setting.
INSTALLED_APPS = [
'django.contrib.admin',
...
'django_quill',
'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.
'django_quill',
'notification',
]
DJANGO_USER_NOTIFICATION = {
"aliyunsms": {
"access_key_id": "Your Access Key ID",
"access_key_secret": "Your Access Key Secret",
"sign_name": "Your Sign Name",
},
"dingtalkchatbot": {
"webhook": "Your Webhook URL",
},
"dingtalkworkmessage": {
"agent_id": "Your App Agent ID",
"app_key": "Your App Key",
"app_secret": "Your App Secret",
},
"dingtalktodotask": {
"app_key": "Your App Key",
"app_secret": "Your 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, need install extension:channels
.AliyunSMSNotificationBackend
: send aliyun sms notification, need install extension:aliyunsms
.DingTalkChatbotNotificationBackend
: send dingtalk chatbot notification.DingTalkToDoTaskNotificationBackend
: send dingtalk todo tasks notificationDingTalkWorkMessageNotificationBackend
: send dingtalk work message notification.WechatNotificationBackend
: planning...
Running the tests
To run the tests against the current environment:
$ pytest tests/
Changelog
0.7.0
- Initial release
Contributing
As an open source project, we welcome contributions. The code lives on GitHub
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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a225a7dd69ed1cb96bc73d4998f889c804f797788d46ba44486f6fed9e7c0d4 |
|
MD5 | 9103696bed3d8424ac325c074df72167 |
|
BLAKE2b-256 | 0f16f12e9e9b68e884dc3fc33c9c5d9ee6a96eea619cb85c176d9758219267e6 |
Hashes for django_user_notification-0.7.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5ad097649b7ce7c13eb8a242779359871f95d7bb620fd956da35eff31a7719e |
|
MD5 | 0d7fc69ea7190d338bddff9a8ff3496a |
|
BLAKE2b-256 | ba16a738ca675f8e1063bd9fbdd5046e7e79eebcca09c6391f7532f834797db8 |