Advanced notifications for Django
Project description
django-whistle
Django Whistle is a Django app that provides a simple way to send notifications via different channels.
Currently supports web, push, email channels.
Basic Usage
- Installation: Install Django Whistle using pip:
pip install django-whistle
- Configuration in settings: Add 'whistle' to your
INSTALLED_APPSin the Django project settings:
# settings.py
INSTALLED_APPS = [
# ...
'whistle',
]
Configuration
Customize Django Whistle by configuring settings in your project's settings.py:
Basics
Setup events and channels for notifications like this: Pro tip, you can use TextChoices for events.
# settings.py
WHISTLE_CHANNELS = ['web', 'push', 'email']
WHISTLE_NOTIFICATION_EVENTS = (
('NAME_OF_EVENT', gettext_lazy('Object %(object)r was updated')
)
### Custom Notification Manager/Handlers
You can ovverride the logic of sending notifications by creating custom manager or handler. Handler is for general
availability of event/channel, and managers is for defining the behaviour. For example, you can use it to customize
emails, add context to emails, or for whatever you miss in the default implementation.
```python
# settings.py
WHISTLE_EMAIL_MANAGER_CLASS = "bidding.notifications.managers.CustomEmailManager"
WHISTLE_NOTIFICATION_MANAGER_CLASS = (
"bidding.notifications.managers.CustomNotificationManager"
)
WHISTLE_AVAILABILITY_HANDLER = "bidding.notifications.handlers.availability_handler"
Asynchronous Notifications
You can send notifications asynchronously using queues.
# settings.py
WHISTLE_REDIS_QUEUE = None
WHISTLE_USE_RQ = False
RQ_QUEUES = None
WHISTLE_CACHE_TIMEOUT = None # infinite
Running the tests
Explain how to run the automated tests for this system
Break down into end to end tests
Explain what these tests test and why
Give an example
And coding style tests
Explain what these tests test and why
Give an example
Deployment
Add additional notes about how to deploy this on a live system
Built With
- Dropwizard - The web framework used
- Maven - Dependency Management
- ROME - Used to generate RSS Feeds
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Billie Thompson - Initial work - PurpleBooth
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
- Hat tip to anyone who's code was used
- Inspiration
- etc
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
File details
Details for the file django_whistle-5.0.1.tar.gz.
File metadata
- Download URL: django_whistle-5.0.1.tar.gz
- Upload date:
- Size: 21.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c2ef394fa133a5a3764d5c36b6e88b584952caf203e0ddd1e38725f6e75781cf |
|
| MD5 | da999cdd594eb0ee9ec2e00252989dfc |
|
| BLAKE2b-256 | 11cb67a495ed0923f183bfecbe052cd7bab7b5e84bba2f2810f21783d1a12ced |
