Skip to main content

Namespaces based configuration for Apphooks

Project description

|PyPI Version| |Build Status| |Coverage Status|


Namespaces based configuration for Apphooks

Basic concepts

The concept of apphooks-config is to store all the configuration
in an applications-specific model, and let the developer
specify the desired option in a form.
In the views the model instance specific for the current
application namespace is loaded (through a mixin) and it's
thus available in the view to provide the configuration for
the current namespace.

Namespaces can be created on the fly in the ``Page`` admin
**Advanced settings** by following the steps above.
When creating an application configuration, you are in fact defining a
namespace, which is saved in the same field in the ``Page`` model as the
plain namespaces.

Implementation step-guide

* Define a AppHookConfig model in ````::

from aldryn_apphooks_config.models import AppHookConfig

class NewsBlogConfig(AppHookConfig):

Implementation can be completely empty as the schema is defined in the
parent (abstract) model

* Use apphooks managers in your model::

from aldryn_apphooks_config.managers import AppHookConfigManager

class Article(models.Model):
title = models.CharField()

objects = AppHookConfigManager()

``AppHookConfigManager`` adds ``namespace`` method to manager and queryset::


There is also a proper queryset, the ``ApphooksConfigQueryset``. Parler
integrated variants can be found in ``aldryn_apphooks_config.managers.parler``.
Names are ``AppHookConfigTranslatableManager`` and

* Define a ConfigForm in ````::

from app_data import AppDataForm
from django import forms
from aldryn_newsblog.models import NewsBlogConfig
from aldryn_apphooks_config.utils import setup_config

class BlogOptionForm(AppDataForm):
# fields are totally arbitrary: any form field supported by
# django-appdata is supported
show_authors = forms.BooleanField(required=False)

# this function will register the provided form with the model created
# at the above step
setup_config(BlogOptionForm, NewsBlogConfig)

* Define an admin class for the AppHookConfig model (usually in ````::

from django.contrib import admin
from aldryn_apphooks_config.admin import BaseAppHookConfig

class BlogConfigAdmin(BaseAppHookConfig):

def get_config_fields(self):
# this method **must** be implemented and **must** return the
# fields defined in the above form, with the ``config`` prefix
# This is dependent on the django-appdata API
return ('config.show_authors', ...)

* Define a CMSApp derived from CMSConfigApp provided by this application
(in ````/````)::

from aldryn_apphooks_config.app_base import CMSConfigApp
from cms.apphook_pool import apphook_pool
from django.utils.translation import ugettext_lazy as _
from .models import NewsBlogConfig

class NewsBlogApp(CMSConfigApp):
name = _('NewsBlogApp')
urls = ['aldryn_newsblog.urls']
app_name = 'aldryn_newsblog'
# this option is specific of CMSConfigApp, and links the
# CMSApp to a specific AppHookConfig model
app_config = NewsBlogConfig


* Implements your views inheriting the ``AppConfigMixin``::

from django.views.generic.detail import DetailView
from aldryn_apphooks_config.mixins import AppConfigMixin

class ArticleDetail(AppConfigMixin, DetailView):
def get_queryset(self):
return Article.objects.namespace(self.namespace)

``AppConfigMixin`` provides a complete support to namespaces, so the view
is not required to set anything specific to support them; the following
attributes are set for the view class instance:

* current namespace in ``self.namespace``
* namespace configuration (the instance of NewsBlogConfig) in ``self.config``
* current application in the ``current_app`` parameter passed to the
Response class

Test setup

To properly setup the data for tests to run for a apphook-config enabled application,
make sure you add the following code to your TestCase::


def setUp(self):
# This is the namespace represented by the AppHookConfig model instance
self.ns_newsblog = NewsBlogConfig.objects.create(namespace='NBNS') = api.create_page(
'page', self.template, self.language, published=True,
# this is the name of the apphook defined in the CMSApp class
# The namespace is the namespace field of the AppHookConfig instance created above
# publish the page to make the apphook available

.. |PyPI Version| image::
.. |Build Status| image::
.. |Coverage Status| image::


0.3.0 (2017-01-06)

* Allowed override AppHookConfigField attributes
* Drop Django 1.7 and below
* Drop django CMS 3.1 and below
* Add Django 1.10 support

0.2.7 (2016-03-03)

* Set namespace as readonly
* Add official Django 1.9 support
* Update readme
* Use path_info instead of path in resolve

0.2.6 (2015-10-05)

* Add support for Python 3.5
* Add support for Django 1.9a1
* Code style cleanup and tests

0.2.5 (2015-09-25)

* Add support for Django 1.8, django CMS 3.2
* AppHookConfigTranslatableManager.get_queryset should use queryset_class
* Skip overriding admin form if app_config field not present

0.2.4 (2015-04-20)

* Fixes issue where an apphook could not be changed, once set.
* Addes optional 'default' kwarg to namespace_url templatetag

0.1.0 (2014-01-01)

* First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aldryn-apphooks-config, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size aldryn_apphooks_config-0.3.0-py2.py3-none-any.whl (32.0 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size aldryn-apphooks-config-0.3.0.tar.gz (21.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page