Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amirhamiri/django-admin-notification
django-admin-notification is a Django app to display notification in Django admin panel.
https://github.com/amirhamiri/django-admin-notification
admin django notifications python
Last synced: about 23 hours ago
JSON representation
django-admin-notification is a Django app to display notification in Django admin panel.
- Host: GitHub
- URL: https://github.com/amirhamiri/django-admin-notification
- Owner: amirhamiri
- License: mit
- Created: 2022-08-03T01:37:06.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-14T09:02:50.000Z (11 months ago)
- Last Synced: 2024-03-14T14:02:59.220Z (8 months ago)
- Topics: admin, django, notifications, python
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 80
- Watchers: 1
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-admin-notification
django-admin-notification is a Django app to display notification in Django admin panel.
## Installation
- Run `pip install django-admin-notification`
- Add `admin_notification` to `settings.INSTALLED_APPS` **before** `django.contrib.admin`
```python
INSTALLED_APPS = (
#...
"admin_notification",
#...
"django.contrib.admin",
#...
)
```
## Settings
`NOTIFICATION_MODELS`: A list of models which you want to get notified about them in the django admin panel. the correct format for each element of the list is `app.model`
```python
NOTIFICATION_MODELS = ['myapp.MyModel']
```
`ADMIN_SITE_BASE_URL`: An string representing the url to django admin page, if you have changed the base url of the admin site in settings.py, the default is `"admin/"`:
```python
ADMIN_SITE_BASE_URL = 'admin_site_base_url/'
```
## Urls
`check_notifications`: This view is needed to keep track of notifications and redirecting to the corresponding models admin page. you must add this view into your urls list.
```python
...
from admin_notification.views import check_notification_view
urlpatterns = [
path('check/notification', check_notification_view, name="check_notifications"),
...
]
```
> Note: You are free to change the url but keep the name the same as it is in the example.
## Run
- Run `python manage.py migrate`
- Restart your application server
- Visit http://127.0.0.1:8000/admin/
- Create an instance of any of the NOTIFICATION_MODELS and enjoy :)
