aldryn-addons 2.0.1

Installation

aldryn-addons is part of the Divio Cloud platform.

For a manual install:

Add aldryn-addons to your projects requirements.txt or pip install it. It is also highly recommended to install aldryn-django. This is django itself bundled as an addon:

pip install aldryn-addons aldryn-django==1.6.11

At the top if the settings.py add 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

Addons can automatically add code 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.urls import re_path, 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
    re_path(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-django-cms for the examples below.

Adding Addons

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

pip install the Addon:

pip install djangocms-link

Add it to INSTALLED_ADDONS in settings.py:

INSTALLED_ADDONS = [
    'aldryn-django',
    'aldryn-cms',
    'djangocms-link',
]

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

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

Running Tests

You can run tests by executing:

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test