Merge pull request #16 from farridav/trodriguez/upgrade_to_adminlte3

Upgrade to adminlte3

Author: farridav

.gitignore

@@ -10,3 +10,5 @@
 /test-reports
 __pycache__
 _resource
+admin_templates
+*.sqlite3

README.md

@@ -35,7 +35,7 @@ JAZZMIN_SETTINGS = {
     'site_header': 'Django',
 
     # square logo to use for your site, must be present in static files, used for favicon and brand on top left
-    'site_logo': 'admin/dist/img/default-log.svg',
+    'site_logo': 'jazzmin/img/default-log.svg',
 
     # Welcome text on the login screen
     'welcome_sign': 'Welcome',

README.rst

@@ -38,7 +38,7 @@ Setup & configuration
         'site_header': 'Django',
 
         # square logo to use for your site, must be present in static files, used for favicon and brand on top left
-        'site_logo': 'admin/dist/img/default-log.svg',
+        'site_logo': 'jazzmin/img/default-log.svg',
 
         # Welcome text on the login screen
         'welcome_sign': 'Welcome',

dev-requirements.txt

@@ -1,12 +1,18 @@
 -e .
 
-wheel
-setuptools
-twine
-flake8
-pytest
-pytest-django
-tox-gh-actions
-coverage
-tox
-tox-pyenv
+wheel                 # python packaging support
+setuptools            # python packaging support
+twine                 # python packaging tools
+flake8                # Static code checking
+pytest                # Test runner
+pytest-django         # Django integration for pytest
+tox-gh-actions        # Github actions support for tox
+coverage              # Measure code coverage durign tests
+tox                   # Test runner for python packages
+tox-pyenv             # pyenv support for tox
+django-debug-toolbar  # unparallelled debugging in django
+werkzeug              # support for werkzeug debugger in runserver_plus
+ipython               # enhanced python shell
+ipdb                  # ipython breakpoints
+django-extensions     # Django Sugar for development
+faker                 # less fake fake data

docs/dashboard.png

@@ -1,31 +1,4 @@
-import logging
-
-from django.contrib import admin
-
 try:
     from django.urls import reverse, resolve, NoReverseMatch  # NOQA
 except ImportError:
     from django.core.urlresolvers import reverse, resolve, NoReverseMatch  # NOQA
-
-logger = logging.getLogger(__name__)
-
-
-def get_available_apps(context):
-    # Django 1.9+
-    available_apps = context.get('available_apps', [])
-    request = context.get('request')
-
-    if not available_apps:
-
-        # Django 1.8 on app index only
-        available_apps = context.get('app_list')
-
-        # Django 1.8 on rest of the pages
-        if not available_apps and request:
-            template_response = admin.site(request.current_app).index(request)
-            available_apps = template_response.context_data['app_list']
-
-    if not available_apps:
-        logger.warning('Unable to retrieve apps list for menu.')
-
-    return available_apps

docs/detail_view.png

@@ -3,7 +3,7 @@
 from django.conf import settings
 from django.contrib.admin import AdminSite
 
-from .utils import get_admin_url
+from .utils import get_admin_url, get_custom_url, get_model_meta, get_app_admin_urls
 
 DEFAULT_SETTINGS = {
     # Choose from black, black-light, blue, blue-light, green, green-light, purple, purple-light
@@ -17,38 +17,44 @@
     'site_header': AdminSite.site_header,
 
     # square logo to use for your site, must be present in static files, used for favicon and brand on top left
-    'site_logo': 'admin/dist/img/default-log.svg',
+    'site_logo': 'adminlte/img/AdminLTELogo.png',
 
     # Welcome text on the login screen
-    'welcome_sign': 'Welcome big dog',
+    'welcome_sign': 'Welcome',
 
     # Copyright on the footer
-    'copyright': 'Acme Ltd',
-
-    # Whether to aut expand the menu
-    'navigation_expanded': True,
+    'copyright': '',
 
     # The model admin to search from the search bar, search bar omitted if excluded
-    'search_model': 'profiles.Profile',
+    'search_model': None,
 
     # Field name on user model that contains avatar image
     'user_avatar': 'avatar',
 
-    # Hide these apps when generating menu
+    # Links to put along the top menu
+    'topmenu_links': [],
+
+    #############
+    # Side Menu #
+    #############
+
+    # Whether to display the side menu
+    'show_sidebar': True,
+
+    # Whether to aut expand the menu
+    'navigation_expanded': True,
+
+    # Hide these apps when generating side menu
     'hide_apps': [],
 
-    # Hide these models when generating menu
+    # Hide these models when generating side menu
     'hide_models': [],
 
-    # List of apps to base menu ordering off of
-    'order_with_respect_to': ['profiles', 'devices'],
+    # List of apps to base side menu ordering off of
+    'order_with_respect_to': [],
 
     # Custom links to append to app groups, keyed on app name
-    'custom_links': {
-        'profiles': [
-            {'name': 'Custom link', 'url': '/', 'icon': 'fa-user', 'permissions': []}
-        ]
-    },
+    'custom_links': {},
 
     # Custom icons per app or model
     'icons': {
@@ -60,13 +66,23 @@
 
 def get_settings():
     jazzmin_settings = copy.deepcopy(DEFAULT_SETTINGS)
-    user_settings = getattr(settings, 'JAZZMIN_SETTINGS', {})
+    user_settings = {x: y for x, y in getattr(settings, 'JAZZMIN_SETTINGS', {}).items() if y is not None}
     jazzmin_settings.update(user_settings)
 
     if jazzmin_settings['search_model']:
         jazzmin_settings['search_url'] = get_admin_url(jazzmin_settings['search_model'].lower())
         jazzmin_settings['search_name'] = jazzmin_settings['search_model'].split('.')[-1] + 's'
 
+    for link in jazzmin_settings.get('topmenu_links', []):
+        if 'url' in link:
+            link['url'] = get_custom_url(link['url'])
+        elif 'model' in link:
+            link['name'] = get_model_meta(link['model']).verbose_name_plural.title()
+            link['url'] = get_admin_url(link['model'])
+        elif 'app' in link:
+            link['name'] = link['app'].title()
+            link['app_children'] = get_app_admin_urls(link['app'])
+
     jazzmin_settings['hide_apps'] = [x.lower() for x in jazzmin_settings['hide_apps']]
     jazzmin_settings['hide_models'] = [x.lower() for x in jazzmin_settings['hide_models']]