django-admin-interface 0.5.5

django-admin-interface is a modern responsive flat admin interface customizable by the admin itself.

|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