django_diazo 0.4

Integrate Diazo in Django using WSGI middleware and add/change themes using the Django Admin interface.

Integrate Diazo in Django using WSGI middleware and add/change themes using the Django Admin interface.

The code is maintained on GitHub (https://github.com/Goldmund-Wyldebeast-Wunderliebe/django-diazo).

Installation

settings.py

INSTALLED_APPS = (
    ...
    'django_diazo',
    ...
)

We highly recommend to use the following code as the first lines of your settings file. It’s just a good practice:

import os

PROJECT_DIR = os.path.dirname(os.path.dirname(__file__))  # Level of manage.py
BASE_DIR = os.path.dirname(PROJECT_DIR)  # Level of virtualenv

You might want to supply your Django application with an out-of-the-box theme, probably also managed in a VCS.

Create a new app with a diazo.py file in its root. The contents of this file is should be something like this:

from django_diazo.theme import DiazoTheme, registry

class BootstrapTheme(DiazoTheme):
    name = 'Bootstrap Theme'
    slug = 'bootstrap_theme'
registry.register(BootstrapTheme)

To synchronize the built-in themes with the database/application run the following command:

python manage.py syncthemes

wsgi.py

Add the following lines to your wsgi.py file:

# Apply WSGI middleware here.
from django_diazo.wsgi import DiazoMiddlewareWrapper
application = DiazoMiddlewareWrapper(application)

Database (South migrations)

Migrate the database:

python manage.py migrate django_diazo

Uploaded themes

By default, the .zip files that are uploaded are extracted in the media folder. You might want to serve these files in debug mode. Add the following to your urls.py:

if settings.DEBUG:
    urlpatterns += patterns('',
       url(r'^%s/themes/(?P<path>.*)$' % settings.MEDIA_URL.strip('/'), 'django.views.static.serve',
           {'document_root': os.path.join(settings.MEDIA_ROOT, 'themes'), 'show_indexes': True}),
    )

For production environments it is not recommended to serve files from the media folder. This implementation only servers files in the themes folder within the media folder but it would be better to serve these files using a web server and not via Django.

Logging

If you want logging of the errors that might occur in the Diazo transformation, add the following to settings.py:

DIAZO_LOG_FILE = '/var/log/django_diazo.log'

LOGGING = {
    'formatters': {
        ...
        'verbose': {
            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
        },
        'simple': {
            'format': '%(levelname)s %(message)s'
        },
        ...
    },
    'handlers': {
        ...
        'django_diazo_file': {
            'level': 'INFO',
            'class': 'logging.FileHandler',
            'formatter': 'verbose',
            'filename': DIAZO_LOG_FILE,
        },
        'console':{
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        ...
    },
    'loggers': {
        ...
        'django_diazo': {
            'handlers': ['django_diazo_file', 'console'],
            'level': 'INFO',
            'propagate': True,
        },
        ...
    },
}

Example themes / application

Take a look at https://github.com/Goldmund-Wyldebeast-Wunderliebe/django-diazo-themes and https://github.com/Goldmund-Wyldebeast-Wunderliebe/django-diazo-blog for examples of built-in themes and an integration example.