Updated version

README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://travis-ci.org/fabiocaccamo/django-admin-interface.svg?branch=master)](https://travis-ci.org/fabiocaccamo/django-admin-interface)
 [![codecov](https://codecov.io/gh/fabiocaccamo/django-admin-interface/branch/master/graph/badge.svg)](https://codecov.io/gh/fabiocaccamo/django-admin-interface)
+[![Code Health](https://landscape.io/github/fabiocaccamo/django-admin-interface/master/landscape.svg?style=flat)](https://landscape.io/github/fabiocaccamo/django-admin-interface/master)
 [![PyPI version](https://badge.fury.io/py/django-admin-interface.svg)](https://badge.fury.io/py/django-admin-interface)
 [![Py versions](https://img.shields.io/pypi/pyversions/django-admin-interface.svg)](https://img.shields.io/pypi/pyversions/django-admin-interface.svg)
 [![License](https://img.shields.io/pypi/l/django-admin-interface.svg)](https://img.shields.io/pypi/l/django-admin-interface.svg)
@@ -84,6 +85,12 @@ You can add a theme you've created through the admin to this repository by [send
 ###### Admin theme customization
 ![django-admin-interface_theme_customization](https://cloud.githubusercontent.com/assets/1035294/11240250/7350d942-8df1-11e5-9b28-f2f54c333cdc.gif)
 
+## FAQ
+- #### I already have a custom `base_site.html`, how can I make it work?
+
+You can use [django-apptemplates](https://github.com/bittner/django-apptemplates), then add **`{% extends "admin_interface:admin/base_site.html" %}`** to your `base_site.html`
+
+---
 #### Thanks
 - [django-flat-theme](https://github.com/elky/django-flat-theme/)
 - [django-flat-responsive](https://github.com/elky/django-flat-responsive)

README.rst

@@ -0,0 +1,181 @@
+|Build Status| |codecov| |Code Health| |PyPI version| |Py versions|
+|License|
+
+django-admin-interface
+======================
+
+django-admin-interface is a modern **responsive flat admin interface
+customizable by the admin itself**.
+
+Features
+--------
+
+-  Beautiful default **django-theme**
+-  Themes management and customization *(you can **customize admin
+   title, logo and colors**)*
+-  Responsive
+-  List filter dropdown *(optional)*
+-  **``NEW``** **Related modal** *(instead of the old popup window,
+   optional)*
+-  Style optimizations for: ``django-ckeditor``,
+   ``django-modeltranslation``, ``sorl-thumbnail``
+
+Requirements
+------------
+
+-  Python 2.7, 3.4, 3.5, 3.6
+-  Django 1.7, 1.8, 1.9, 1.10, 1.11
+
+Installation
+------------
+
+-  Run ``pip install django-admin-interface``
+-  Add ``admin_interface``, ``flat_responsive``, ``flat`` and
+   ``colorfield`` to ``settings.INSTALLED_APPS`` **before**
+   ``django.contrib.admin``
+
+   .. code:: python
+
+       INSTALLED_APPS = (
+       #...
+       'admin_interface',
+       'flat_responsive',
+       'flat', # only if django version < 1.9
+       'colorfield',
+       #...
+       'django.contrib.admin',
+       #...
+       )
+
+-  Run ``python manage.py migrate``
+-  Run ``python manage.py collectstatic``
+-  Restart your application server
+
+Upgrade
+~~~~~~~
+
+-  Run ``pip install django-admin-interface --upgrade``
+-  Run ``python manage.py migrate`` *(add ``--fake-initial`` if you are
+   upgrading from 0.1.0 version)*
+-  Run ``python manage.py collectstatic --clear``
+-  Restart your application server
+
+Optional themes
+---------------
+
+This package ships with optional themes as fixtures, they can be
+installed using the `loaddata admin
+command <https://docs.djangoproject.com/en/1.11/ref/django-admin/#django-admin-loaddata>`__.
+Optional themes are activated on installation.
+
+`Django <https://www.djangoproject.com/>`__ theme (default):
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Run ``python manage.py loaddata admin_interface_theme_django.json``
+
+`Bootstrap <http://getbootstrap.com/>`__ theme:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Run ``python manage.py loaddata admin_interface_theme_bootstrap.json``
+
+`Foundation <http://foundation.zurb.com/>`__ theme:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Run ``python manage.py loaddata admin_interface_theme_foundation.json``
+
+`U.S. Web Design Standards <https://standards.usa.gov/>`__ theme:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Run ``python manage.py loaddata admin_interface_theme_uswds.json``
+
+Add more themes
+~~~~~~~~~~~~~~~
+
+You can add a theme you've created through the admin to this repository
+by `sending us a PR <http://makeapullrequest.com/>`__. Here are the
+steps to follow to add :
+
+1. Export your exact theme as fixture using the ``dumpdata`` admin
+   command:
+   ``python manage.py dumpdata admin_interface.Theme --indent 4 -o admin_interface_theme_{{name}}.json --pks=N``
+
+2. Copy the generated json file into the fixtures folder *(making sure
+   its name starts with ``admin_interface_theme_`` to avoid clashes with
+   fixtures that might be provided by other third party apps)*.
+
+3. Remove the ``"pk"`` from the fixture and make sure the ``active``
+   field is set to ``true`` *(in this way a theme is automatically
+   activated when installed)*.
+
+4. Edit the section above to document your theme.
+
+Screenshots
+-----------
+
+Admin login
+~~~~~~~~~~~
+
+|django-admin-interface\_login|
+-------------------------------
+
+Admin dashboard
+~~~~~~~~~~~~~~~
+
+|django-admin-interface\_dashboard|
+-----------------------------------
+
+Admin themes management
+~~~~~~~~~~~~~~~~~~~~~~~
+
+|django-admin-interface\_themes\_management|
+--------------------------------------------
+
+Admin theme customization
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. figure:: https://cloud.githubusercontent.com/assets/1035294/11240250/7350d942-8df1-11e5-9b28-f2f54c333cdc.gif
+   :alt: django-admin-interface\_theme\_customization
+
+   django-admin-interface\_theme\_customization
+
+FAQ
+---
+
+-  .. rubric:: I already have a custom ``base_site.html``, how can I
+      make it work?
+      :name: i-already-have-a-custom-base_site.html-how-can-i-make-it-work
+
+You can use
+`django-apptemplates <https://github.com/bittner/django-apptemplates>`__,
+then add **``{% extends "admin_interface:admin/base_site.html" %}``** to
+your ``base_site.html``
+
+--------------
+
+Thanks
+~~~~~~
+
+-  `django-flat-theme <https://github.com/elky/django-flat-theme/>`__
+-  `django-flat-responsive <https://github.com/elky/django-flat-responsive>`__
+-  `django-colorfield <https://github.com/jaredly/django-colorfield/>`__
+
+License
+-------
+
+Released under `MIT License <LICENSE>`__.
+
+.. |Build Status| image:: https://travis-ci.org/fabiocaccamo/django-admin-interface.svg?branch=master
+   :target: https://travis-ci.org/fabiocaccamo/django-admin-interface
+.. |codecov| image:: https://codecov.io/gh/fabiocaccamo/django-admin-interface/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/fabiocaccamo/django-admin-interface
+.. |Code Health| image:: https://landscape.io/github/fabiocaccamo/django-admin-interface/master/landscape.svg?style=flat
+   :target: https://landscape.io/github/fabiocaccamo/django-admin-interface/master
+.. |PyPI version| image:: https://badge.fury.io/py/django-admin-interface.svg
+   :target: https://badge.fury.io/py/django-admin-interface
+.. |Py versions| image:: https://img.shields.io/pypi/pyversions/django-admin-interface.svg
+   :target: https://img.shields.io/pypi/pyversions/django-admin-interface.svg
+.. |License| image:: https://img.shields.io/pypi/l/django-admin-interface.svg
+   :target: https://img.shields.io/pypi/l/django-admin-interface.svg
+.. |django-admin-interface\_login| image:: https://cloud.githubusercontent.com/assets/1035294/11240233/55c8d4ba-8df1-11e5-9568-00fdc987ede8.gif
+.. |django-admin-interface\_dashboard| image:: https://cloud.githubusercontent.com/assets/1035294/11240239/627c0362-8df1-11e5-81fa-216366a5d8da.gif
+.. |django-admin-interface\_themes\_management| image:: https://cloud.githubusercontent.com/assets/1035294/11240245/6cd1c342-8df1-11e5-928b-f22217474d3d.gif

admin_interface/admin.py

@@ -19,6 +19,10 @@ class ThemeAdmin(admin.ModelAdmin):
             'classes': ('wide', ),
             'fields': ('logo', 'logo_color', 'logo_visible', )
         }),
+        ('Favicon', {
+            'classes': ('wide', ),
+            'fields': ('favicon', )
+        }),
         ('Title', {
             'classes': ('wide', ),
             'fields': ('title', 'title_color', 'title_visible', )

admin_interface/migrations/0007_add_favicon.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11 on 2017-08-24 10:49
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('admin_interface', '0006_bytes_to_str'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='theme',
+            name='favicon',
+            field=models.FileField(blank=True, help_text='(.ico|.png|.gif - 16x16|32x32 px)', upload_to='admin-interface/favicon/', verbose_name='favicon'),
+        ),
+    ]

admin_interface/models.py

@@ -31,18 +31,20 @@ class Theme(models.Model):
     def get_active_theme():
 
         objs_active_qs = Theme.objects.filter( active = True )
+        objs_active_ls = list(objs_active_qs)
+        objs_active_count = len(objs_active_ls)
 
-        #get or create default theme and enforce default logo if deleted
+        if objs_active_count == 0:
-        default_obj_active = (objs_active_qs.count() == 0)
+            default_obj, default_obj_created = Theme.objects.get_or_create(pk = '1', defaults = { 'active':True })
-        default_obj, default_obj_created = Theme.objects.get_or_create(pk = '1', defaults = { 'active':default_obj_active })
+            if not default_obj_created:
+                default_obj.set_active()
+            obj = default_obj
 
-        if not default_obj_created and default_obj_active:
+        elif objs_active_count == 1:
-            default_obj.set_active()
+            obj = objs_active_ls[0]
 
-        obj = objs_active_qs.last()
+        elif objs_active_count > 1:
-        objs_active_count = objs_active_qs.count()
+            obj = objs_active_ls[-1]
-
-        if objs_active_count > 1:
             obj.set_active()
 
         return obj
@@ -58,6 +60,8 @@ class Theme(models.Model):
     logo_color = ColorField( blank = True, default = '#FFFFFF', help_text = '#FFFFFF', max_length = 10, verbose_name = 'logo color' )
     logo_visible = models.BooleanField( default = True, verbose_name = 'visible' )
 
+    favicon = models.FileField( upload_to = 'admin-interface/favicon/', blank = True, help_text = '(.ico|.png|.gif - 16x16|32x32 px)', verbose_name = 'favicon' )
+
     css_header_background_color = ColorField( blank = True, default = '#0C4B33', help_text = '#0C4B33', max_length = 10, verbose_name = 'background color' )
     css_header_text_color = ColorField( blank = True, default = '#44B78B', help_text = '#44B78B', max_length = 10, verbose_name = 'text color' )
     css_header_link_color = ColorField( blank = True, default = '#FFFFFF', help_text = '#FFFFFF', max_length = 10, verbose_name = 'link color' )

admin_interface/templates/admin/base_site.html

@@ -38,6 +38,9 @@ https://github.com/fabiocaccamo/django-admin-interface
 {# https://github.com/elky/django-flat-responsive#important-note #}
 <meta name="viewport" content="user-scalable=no, width=device-width, initial-scale=1.0, maximum-scale=1.0">
 <link rel="stylesheet" type="text/css" href="{% static 'admin/css/responsive.css' %}?v={{ version }}" />
+{% if theme.favicon %}
+<link rel="icon" type="image/x-icon" href="{{ theme.favicon.url }}?v={{ version }}" />
+{% endif %}
 {% if theme.related_modal_active %}
 <link rel="stylesheet" type="text/css" href="{% static 'admin_interface/magnific-popup/magnific-popup.css' %}?v={{ version }}" />
 <script type="text/javascript" src="{% static 'admin_interface/magnific-popup/jquery.magnific-popup.js' %}?v={{ version }}"></script>

admin_interface/templates/admin_interface/css/admin-interface-fix.css

@@ -78,14 +78,13 @@
     border: 1px solid transparent;
 }
 
-.admin-interface fieldset.collapse.collapsed a.collapse-toggle {
+.admin-interface fieldset.collapse.collapsed a.collapse-toggle,
-    font-weight: bold;
-    text-transform: lowercase;
-}
-
 .admin-interface fieldset.collapse a.collapse-toggle {
-    font-weight: bold;
+    font-weight: normal;
     text-transform: lowercase;
+    font-size: 12px;
+    text-decoration: underline;
+    padding: 0 1px;
 }
 
 /*

admin_interface/templates/admin_interface/css/admin-interface.css

@@ -58,12 +58,12 @@
 }
 
 .admin-interface fieldset.collapse.collapsed a.collapse-toggle {
-    color:{{ theme.css_generic_link_color }};
+    color:{{ theme.css_module_link_color }};
 }
 
 .admin-interface fieldset.collapse.collapsed a.collapse-toggle:hover,
 .admin-interface fieldset.collapse.collapsed a.collapse-toggle:active {
-    color:{{ theme.css_generic_link_hover_color }};
+    color:{{ theme.css_module_link_hover_color }};
 }
 
 .admin-interface fieldset.collapse a.collapse-toggle {

admin_interface/version.py

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '0.5.1'
+__version__ = '0.5.3'
 

setup.cfg

@@ -1,2 +1,2 @@
 [metadata]
-description-file = README.md
+description-file = README.rst

tests/tests.py

@@ -9,6 +9,8 @@ import random
 import shutil
 
 from admin_interface.models import Theme
+from admin_interface.templatetags import admin_interface_tags as templatetags
+from admin_interface.version import __version__
 
 
 class AdminInterfaceTestCase(TestCase):
@@ -25,7 +27,6 @@ class AdminInterfaceTestCase(TestCase):
         return Template(string).render(context)
 
     def __test_active_theme(self):
-
         theme = Theme.get_active_theme()
         print( theme )
         self.assertTrue(theme != None)
@@ -33,17 +34,14 @@ class AdminInterfaceTestCase(TestCase):
         self.assertEqual(Theme.objects.filter( active = True ).count(), 1);
 
     def test_default_theme_created_if_no_themes(self):
-
         Theme.objects.all().delete()
         self.__test_active_theme()
 
     def test_default_theme_created_if_all_themes_deleted(self):
-
         Theme.objects.all().delete()
         self.__test_active_theme()
 
     def test_default_theme_activated_on_save_if_no_active_themes(self):
-
         Theme.objects.all().delete()
         theme = Theme.get_active_theme()
         theme.active = False
@@ -51,13 +49,11 @@ class AdminInterfaceTestCase(TestCase):
         self.__test_active_theme()
 
     def test_default_theme_activated_after_update_if_no_active_themes(self):
-
         Theme.objects.all().delete()
         Theme.objects.all().update( active = False )
         self.__test_active_theme()
 
     def test_default_theme_activated_after_update_if_multiple_active_themes(self):
-
         Theme.objects.all().delete()
         theme_1 = Theme.objects.create( name = 'Custom 1', active = True )
         theme_2 = Theme.objects.create( name = 'Custom 2', active = True )
@@ -67,7 +63,6 @@ class AdminInterfaceTestCase(TestCase):
         self.__test_active_theme()
 
     def test_default_theme_activated_on_active_theme_deleted(self):
-
         Theme.objects.all().delete()
         theme_1 = Theme.objects.create( name = 'Custom 1', active = True )
         theme_2 = Theme.objects.create( name = 'Custom 2', active = True )
@@ -76,7 +71,6 @@ class AdminInterfaceTestCase(TestCase):
         self.__test_active_theme()
 
     def test_last_theme_activated_on_multiple_themes_created(self):
-
         Theme.objects.all().delete()
         theme_1 = Theme.objects.create( name = 'Custom 1', active = True )
         theme_2 = Theme.objects.create( name = 'Custom 2', active = True )
@@ -85,7 +79,6 @@ class AdminInterfaceTestCase(TestCase):
         self.__test_active_theme()
 
     def test_last_theme_activated_on_multiple_themes_activated(self):
-
         Theme.objects.all().delete()
         theme_1 = Theme.objects.create( name = 'Custom 1', active = True )
         theme_2 = Theme.objects.create( name = 'Custom 2', active = True )
@@ -100,23 +93,32 @@ class AdminInterfaceTestCase(TestCase):
                 self.assertEqual( Theme.get_active_theme().pk, theme.pk )
         self.__test_active_theme()
 
-    def test_templatetags(self):
+    def test_templatetags_get_theme(self):
-
         Theme.objects.all().delete()
         context = Context({})
+        theme = templatetags.get_admin_interface_theme(context)
+        self.assertEqual(theme.name, 'Django')
         rendered = self.__render_template('{% load admin_interface_tags %}{% get_admin_interface_theme as theme %}{{ theme.name }}', context)
         self.assertEqual(rendered, 'Django')
 
-    def test_templatetags_with_request(self):
+    def test_templatetags_get_theme_with_request(self):
-
         Theme.objects.all().delete()
         context = Context({
             'request': self.request_factory.get('/')
         })
+        theme = templatetags.get_admin_interface_theme(context)
+        self.assertEqual(theme.name, 'Django')
         rendered = self.__render_template('{% load admin_interface_tags %}{% get_admin_interface_theme as theme %}{{ theme.name }}', context)
         self.assertEqual(rendered, 'Django')
 
+    def test_templatetags_get_version(self):
+        context = Context({})
+        version = templatetags.get_admin_interface_version(context)
+        self.assertEqual(version, __version__)
+        rendered = self.__render_template('{% load admin_interface_tags %}{% get_admin_interface_version as version %}{{ version }}', context)
+        self.assertEqual(rendered, __version__)
+
     def test_repr(self):
         theme = Theme.get_active_theme()
-        self.assertEqual( "{0}".format(theme), 'Django' )
+        self.assertEqual( '{0}'.format(theme), 'Django' )