Package: aldryn-addons
Aldryn Addonsare re-usable django apps that follow certain conventions to
abstract out complicated configuration from the individual django website
project into upgradable packages. With this approach it is possible
to avoid repetitive “add this toINSTALLED_APPSand that toMIDDLEWARE_CLASSESand add these tourls.py” work. The settings logic
is bundled with the addon and only interesting “meta” settings are exposed.
It is a framework to utilise such addons in django projects.The goal is to keep the footprint inside the django website project as small
as possible, so updating things usually just mean bumping a version inrequirements.txtand no other changes in the project.This addon still uses the legacy “Aldryn” naming. You can read more about this in oursupport section.ContributingThis is a an open-source project. We’ll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your
pull request, please review ourcontribution guidelines.We’re grateful to all contributors who have helped create and maintain this package.
Contributors are listed at thecontributorssection.DocumentationSeeREQUIREMENTSin thesetup.pyfile for additional dependencies:Installationaldryn-addonsis part of the Divio Cloud platform.For a manual install:Addaldryn-addonsto your projectsrequirements.txtor pip install it.
It is also highly recommended to installaldryn-django. This is django
itself bundled as an addon:pip install aldryn-addons aldryn-django==1.6.11At the top if thesettings.pyadd 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 hereAddons can automatically add code to the rooturls.pyso it’s necessary
to addaldryn_addons.urls.patterns()andaldryn_addons.urls.i18n_patterns().
The code below is for Django 1.8 and above. For older versions of Django,
please add the prefix parameter toi18n_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 AddonsIn this example we’re going to installdjango CMS Link,
which requiresAldryn django CMS.pip install the Addon:pip install djangocms-linkAdd it toINSTALLED_ADDONSinsettings.py:INSTALLED_ADDONS = [
    'aldryn-django',
    'aldryn-cms',
    'djangocms-link',
]Copyaldryn_config.pyandaddon.jsonfrom the addon into theaddonsdirectory within your project (addons/djangocms-link/aldryn_config.pyandaddons/djangocms-link/addon.json). Ifaldryn_config.pydefines any
settings on the settings Form, put them inaddons/djangocms-link/settings.json, if not put{}into it.NoteThe need to manually copyaldryn_config.pyandaddon.jsonis
due to legacy compatibility with the Divio Cloud platform and will no
longer be necessary in a later release.NoteFuture versions will include a little webserver with a graphical UI
to edit the settings insettings.json, much like it is provided
on the Divio Cloud platform.You are all set. The code inaldryn_config.pywill take care of configuring
the addon.Running TestsYou can run tests by executing:virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test