Compare commits

...

7 Commits

Author SHA1 Message Date
Fabio Caccamo 0fd8469d9a Updated version 2017-09-27 14:34:28 +02:00
Fabio Caccamo 5cce94eefc Added README.rst [ci skip] 2017-09-27 14:33:52 +02:00
Fabio Caccamo c4c6a2b0f2 Updated README.md [ci skip] 2017-09-11 11:48:57 +02:00
Fabio Caccamo 73a61080ae Added code-quality badge to README - [ci skip] 2017-09-04 17:19:12 +02:00
Fabio Caccamo 0164e5b791 Fixed fieldset collapse show/hide link style [ci skip] 2017-08-29 12:41:29 +02:00
Fabio Caccamo bb29c637ff Fixed tests error 2017-08-24 18:37:28 +02:00
Fabio Caccamo a8e9fffdac Increased coverage 2017-08-24 18:23:35 +02:00
7 changed files with 211 additions and 29 deletions
+7
View File
@@ -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)
+181
View File
@@ -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
@@ -78,14 +78,13 @@
border: 1px solid transparent;
}
.admin-interface fieldset.collapse.collapsed a.collapse-toggle {
font-weight: bold;
text-transform: lowercase;
}
.admin-interface fieldset.collapse.collapsed a.collapse-toggle,
.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;
}
/*
@@ -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 {
+1 -1
View File
@@ -1,4 +1,4 @@
# -*- coding: utf-8 -*-
__version__ = '0.5.2'
__version__ = '0.5.3'
+1 -1
View File
@@ -1,2 +1,2 @@
[metadata]
description-file = README.md
description-file = README.rst
+14 -19
View File
@@ -9,6 +9,7 @@ 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__
@@ -26,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)
@@ -34,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
@@ -52,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 )
@@ -68,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 )
@@ -77,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 )
@@ -86,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 )
@@ -101,28 +93,31 @@ 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_version(self):
context = Context({})
rendered = self.__render_template('{% load admin_interface_tags %}{% get_admin_interface_version as version %}{{ version }}', context)
self.assertEqual(rendered, __version__)
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' )