aldryn-addons 0.1

settings.py

At the top if the settings the following code snippet:

INSTALLED_ADDONS = [
    'aldryn-django',
]

# add your own settings here that are needed by the installed Addons

import aldryn_addons.settings
aldryn_addons.settings.load(locals())

# add any other custom settings here

urls.py

Addons can automatically add stuff to the root urls.py so it’s necessary to add aldryn_addons.urls.patterns() and aldryn_addons.urls.i18n_patterns(). The code below is for Django 1.8 and above. For older versions of Django, please add the prefix parameter to i18n_patterns: i18n_patterns('', ...

from django.conf.urls import url, include
from django.conf.urls.i18n import i18n_patterns
import aldryn_addons.urls


urlpatterns = [
    # add your own patterns here
] + aldryn_addons.urls.patterns() + i18n_patterns(
    # add your own i18n patterns here
    url(r'^myapp/', include('myapp.urls')),
    *aldryn_addons.urls.i18n_patterns()  # MUST be the last entry!
)

Please follow the installation instructions for aldryn-django for complete integration. Then follow the setup instructions for aldryn-cms for the examples below.

Adding Addons

In this example we’re going to install Aldryn Newsblog, which requires django CMS.

pip install the Addon:

pip install aldryn-newsblog

Add it to INSTALLED_ADDONS in settings.py:

INSTALLED_ADDONS = [
    'aldryn-django',
    'aldryn-cms',
    'aldryn-newsblog',
]

Copy aldryn_config.py and addon.json from the Addon into the addons directory within your project (addons/aldryn-newsblog/aldryn_config.py and addons/aldryn-newsblog/addon.json). If aldryn_config.py defines any settings on the settings Form, put them in addons/aldryn-newsblog/settings.json, if not put {} into it.

You are all set. The code in aldryn_config.py will take care of configuring the Addon.