Installation

  1. Install Quade with pip:

    pip install quade
    
  2. Add Quade to your project’s INSTALLED_APPS:

    INSTALLED_APPS = [
        ...
        'quade.apps.QuadeConfig',
    ]
    
  3. Initialize the Quade settings by adding these lines to your Django settings:

    import quade
    
    QUADE = quade.Settings()
    
(By default, Quade will only be available when DEBUG=True. For more details, see Settings.)
  1. Add the django_jinja template handler to your TEMPLATES setting, while retaining any other template handlers you have. For example:

    TEMPLATES = [
        # Existing code, leave in-place
        {
            'BACKEND': 'django.template.backends.django.DjangoTemplates',
            ...
        },
        # New code to add
        {
            'BACKEND': 'django_jinja.backend.Jinja2',
            'DIRS': [],
            'APP_DIRS': True,
            'OPTIONS': {
                'app_dirname': 'jinja2',
            },
        },
    ]
    
  2. Add Quade to your URL configuration, e.g.:

    # urls.py
    
    urlpatterns = [
        ...
        url(r'^quade/', include('quade.urls'))
    ]
    
  3. Run migrations:

    python manage.py migrate quade
    

You’re ready to roll!