Metadata-Version: 2.1
Name: django-jazzmin
Version: 1.0.0
Summary: Django admin theme based adminlte & bootstrap
Home-page: https://github.com/farridav/django-jazzmin
Author: farridav
Maintainer: farridav
License: MIT
Platform: UNKNOWN
Requires-Dist: django (>=1.7)

Django jazzmin (Jazzy Admin)
============================
Drop-in theme for django admin, that utilises AdminLTE & Bootstrap to make yo' admin looky jazzy

This was initially a Fork of https://github.com/wuyue92tree/django-adminlte-ui that I refactored so much I thought it 
deserved its own package, big thanks to @wuyue92tree for all of his initial hard work, I am still patching into that 
project were possible, but this project is taking a slightly different direction.

Installation
============
::

    pip install django-jazzmin

Setup & configuration
=====================
::

    # settings.py

    INSTALLED_APPS = [
        # Place before admin
        'jazzmin',
        'django.contrib.admin',
        [...]
    ]


    JAZZMIN_SETTINGS = {
        # Choose from black, black-light, blue, blue-light, green, green-light, purple, purple-light,
        # red, red-light, yellow, yellow-light
        'skin': 'blue',

        # title of the window
        'site_title': 'Django Admin',

        # Title on the login screen
        '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',

        # Welcome text on the login screen
        'welcome_sign': 'Welcome',

        # Copyright on the footer
        'copyright': 'Acme Ltd',

        # Wether to aut expand the menu
        'navigation_expanded': True,

        # The model admin to search from the search bar, search bar omitted if excluded
        'search_model': 'profiles.Profile',

        # Field name on user model that contains avatar image
        'user_avatar': 'avatar',

        # Hide these apps when generating menu
        'hide_apps': ['auth'],

        # Hide these models when generating menu
        'hide_models': ['auth.user'],

        # List of apps to base menu ordering off of
        'order_with_respect_to': ['first_app', 'second_app'],

        # Custom links to append to app groups, keyed on app name
        'custom_links': {
            'first_app': [
                {'name': 'Custom link', 'url': '/', 'icon': 'fa-user', 'permissions': []}
            ]
        },

        'icons': {
            'auth': 'fa-people',
            'auth.user': 'fa-user',
        }
    }


Screenshots
-----------

Login
~~~~~~~~~

.. image:: docs/login.png
   :width: 400

Dashboard
~~~~~~~~~

.. image:: docs/dashboard.png
   :width: 400

List view
~~~~~~~~~

.. image:: docs/list_view.png
   :width: 400

Detail view
~~~~~~~~~~~

.. image:: docs/detail_view.png
   :width: 400

Thanks
------
- Original Package https://github.com/wuyue92tree/django-adminlte-ui


