========== Django JET

.. image:: https://travis-ci.org/geex-arts/django-jet.svg?branch=master :target: https://travis-ci.org/geex-arts/django-jet

.. image:: https://img.shields.io/discord/346712584415870977.svg
:target: https://discord.me/django-jet

Modern template for Django admin interface with improved functionality

Django JET has two kinds of licenses: open-source (AGPLv3) and commercial. Please note that using AGPLv3 code in your programs make them AGPL compatible too. So if you don't want to comply with that we can provide you a commercial license (visit Home page). The commercial license is designed for using Django JET in commercial products and applications without the provisions of the AGPLv3.

.. image:: https://raw.githubusercontent.com/geex-arts/jet/static/logo.png :width: 500px :height: 500px :scale: 50% :alt: Logo :align: center

• Home page: http://jet.geex-arts.com/
• Live Demo: http://demo.jet.geex-arts.com/admin/
• Documentation: http://jet.readthedocs.org/
• libi.io http://libi.io/library/1683/django-jet
• PyPI: https://pypi.python.org/pypi/django-jet
• Support: https://discord.me/jet-community

Why Django JET?

• New fresh look
• Responsive mobile interface
• Useful admin home page
• Minimal template overriding
• Easy integration
• Themes support
• Autocompletion
• Handy controls

Screenshots

.. image:: https://raw.githubusercontent.com/geex-arts/django-jet/static/screen1_720.png :alt: Screenshot #1 :align: center :target: https://raw.githubusercontent.com/geex-arts/django-jet/static/screen1.png

.. image:: https://raw.githubusercontent.com/geex-arts/django-jet/static/screen2_720.png :alt: Screenshot #2 :align: center :target: https://raw.githubusercontent.com/geex-arts/django-jet/static/screen2.png

.. image:: https://raw.githubusercontent.com/geex-arts/django-jet/static/screen3_720.png :alt: Screenshot #3 :align: center :target: https://raw.githubusercontent.com/geex-arts/django-jet/static/screen3.png

Installation

• Download and install latest version of Django JET:

.. code:: bash

pip install git+https://github.com/jet-community/django-jet.git@master

Use the --upgrade option if you already have any version of django-jet currently installed:

.. code:: bash

pip install git+https://github.com/jet-community/django-jet.git@master --upgrade

If you have a requirements.txt file, then add this line to it:

.. code:: bash

git+https://github.com/jet-community/django-jet.git@master

And finally issue the following command:

.. code:: bash

pip install -r requirements.txt

Again, if you already have any version of django-jet currently installed, then use the --upgrade option:

.. code:: bash

pip install -r requirements.txt --upgrade

• Add 'jet' application to the INSTALLED_APPS setting of your Django project settings.py file (note it should be before 'django.contrib.admin'):

.. code:: python

INSTALLED_APPS = (
    ...
    'jet',
    'django.contrib.admin',
)

• Make sure django.template.context_processors.request context processor is enabled in settings.py (Django 1.8+ way):

.. code:: python

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                ...
                'django.template.context_processors.request',
                ...
            ],
        },
    },
]

.. warning:: Before Django 1.8 you should specify context processors different way. Also use django.core.context_processors.request instead of django.template.context_processors.request.

.. code:: python

    from django.conf import global_settings

    TEMPLATE_CONTEXT_PROCESSORS = global_settings.TEMPLATE_CONTEXT_PROCESSORS + (
        'django.core.context_processors.request',
    )

• Add URL-pattern to the urlpatterns of your Django project urls.py file (they are needed for related–lookups and autocompletes):

.. code:: python

urlpatterns = patterns(
    '',
    url(r'^jet/', include('jet.urls', 'jet')),  # Django JET URLS
    url(r'^admin/', include(admin.site.urls)),
    ...
)

• Create database tables:

.. code:: python

python manage.py migrate jet
# or 
python manage.py syncdb

• Collect static if you are in production environment:

.. code:: python

    python manage.py collectstatic

• Clear your browser cache

Dashboard installation

.. note:: Dashboard is located into a separate application. So after a typical JET installation it won't be active. To enable dashboard application follow these steps:

• Add 'jet.dashboard' application to the INSTALLED_APPS setting of your Django project settings.py file (note it should be before 'jet'):

.. code:: python

INSTALLED_APPS = (
    ...
    'jet.dashboard',
    'jet',
    'django.contrib.admin',
    ...
)

• Add URL-pattern to the urlpatterns of your Django project urls.py file (they are needed for related–lookups and autocompletes):

.. code:: python

urlpatterns = patterns(
    '',
    url(r'^jet/', include('jet.urls', 'jet')),  # Django JET URLS
    url(r'^jet/dashboard/', include('jet.dashboard.urls', 'jet-dashboard')),  # Django JET dashboard URLS
    url(r'^admin/', include(admin.site.urls)),
    ...
)

• For Google Analytics widgets only install python package:

.. code::

pip install google-api-python-client==1.4.1

• Create database tables:

.. code:: python

python manage.py migrate dashboard
# or
python manage.py syncdb

• Collect static if you are in production environment:

.. code:: python

    python manage.py collectstatic