django-fluent-dashboard
The fluent_dashboard module offers a custom admin dashboard, built on top of django-admin-tools (docs).
The django-admin-tools package provides a default mechanism to replace the standard Django admin homepage with a widget based dashboard. The fluent_dashboard module extends this, by providing additional widgets (called "modules") such as:
- a "icon list" module for the admin homepage.
- a "welcome" module for the admin homepage.
- a configurable module layout for the admin homepage, through
settings.py. - a "return to site" link.
- an optional "cache statistics" module.
Documentation can be found at: https://django-fluent-dashboard.readthedocs.io/
Screenshot
Installation
First install the module, preferably in a virtual environment. It can be installed from PyPI:
pip install django-fluent-dashboard
Or the current folder can be installed:
pip install .
Configuration
Add the following settings to settings.py:
INSTALLED_APPS += (
'fluent_dashboard',
# enable the admin
'admin_tools',
'admin_tools.theming',
'admin_tools.menu',
'admin_tools.dashboard',
'django.contrib.admin',
)
ADMIN_TOOLS_INDEX_DASHBOARD = 'fluent_dashboard.dashboard.FluentIndexDashboard'
ADMIN_TOOLS_APP_INDEX_DASHBOARD = 'fluent_dashboard.dashboard.FluentAppIndexDashboard'
ADMIN_TOOLS_MENU = 'fluent_dashboard.menu.FluentMenu'
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': (),
'OPTIONS': {
'loaders': (
...
'admin_tools.template_loaders.Loader', # Add this line!
),
}
}
]
The admin_tools.theming and admin_tools.menu applications are optional.
Add to urls.py:
urlpatterns += [
url(r'^admintools/', include('admin_tools.urls')),
]
The database tables for admin_tools can be created afterwards:
./manage.py migrate
Customizing the dashboard
Adding extra icons
The FLUENT_DASHBOARD_APP_ICONS setting is a dictionary that allows you to define extra icons for your own modules, and overwrite default settings. For example:
FLUENT_DASHBOARD_APP_ICONS = {
'auth/user': "user.png"
}
The icon is expected to be 48x48 pixels. The icon name is treated in 3 different formats:
- Absolute URLs are passed as-is.
- Icon names with a / character, are relative to the
STATIC_URL. - Icon names without any path information, are relative to the current theme folder, e.g. STATIC_URL/fluent_dashboard/themename/
Organizing the application groups
The FLUENT_DASHBOARD_APP_GROUPS setting defines which applications are grouped. For example:
FLUENT_DASHBOARD_APP_GROUPS = (
(_('CMS'), {
'models': (
'cms.*',
'pages.*',
'fiber.*',
),
'module': 'CmsAppIconList',
'collapsible': False,
}),
(_('Interactivity'), {
'models': (
'django.contrib.comments.*',
'form_designer.*'
'threadedcomments.*',
'zinnia.*',
),
}),
(_('Administration'), {
'models': (
'django.contrib.auth.*',
'django.contrib.sites.*',
'google_analytics.*',
'registration.*',
),
}),
(_('Applications'), {
'models': ('*',),
'module': 'AppList',
'collapsible': True,
}),
)
Details about these options, and additional settings are explained in the documentation.
Displaying cache status
This application features optional support for the dashboardmods package, which can display cache statistics. It can be installed using:
pip install dashboardmods
The application requires the cache backends to be configured, for example:
INSTALLED_APPS += (
'dashboardmods',
)
# Example Memcache configuration:
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
'KEY_PREFIX': 'mysite.production',
'LOCATION': '127.0.0.1:11211',
'TIMEOUT': 24*3600,
},
}
# Optional, example Varnish configuration:
VARNISH_MANAGEMENT_ADDRS = ('127.0.0.1:6082',)
When a cache is not configured, it will simply not be displayed by the module.
Related applications
The following packages provide additional modules, which can be displayed at the dashboard:
- django-admin-user-stats adds graphs to the dashboard, to see the number of registered users in the last month.
- django-admin-tools-stats is derived from the previous package, and adds configurable graphs for any model type.
- dashboardmods is detected to display cache statistics, but also features a configure RSS feed module.
- django-admin-tools should not be forgotten, because it also provides modules for RSS feeds, link lists and tab grouping.
These modules can be integrated by subclassing the FluentIndexDashboard class, and point to that module with the ADMIN_TOOLS_INDEX_DASHBOARD setting.
Contributing
This module is designed to be generic. In case there is anything you didn't like about it, or think it's not flexible enough, please let us know. We'd love to improve it!
If you have any other valuable contribution, suggestion or idea, please let us know as well because we will look into it. Pull requests are welcome too. :-)
3.4k Dec 29, 2022
731 Dec 28, 2022
1.6k Jan 2, 2023
524 Dec 26, 2022
1.3k Dec 27, 2022
17 Nov 16, 2022
248 Sep 2, 2022
6 Nov 23, 2022
4.7k Dec 31, 2022
3.4k Dec 31, 2022
1.6k Dec 28, 2022
1.3k Dec 31, 2022
1.2k Dec 29, 2022
2.2k Dec 29, 2022
2.6k Jan 7, 2023
907 Dec 31, 2022
326 Dec 3, 2022
258 Nov 30, 2022
236 Dec 15, 2022