kotti_settings 0.1b1

Settings configuration for Kotti

Add a settings configuration to your Kotti site.

Find out more about Kotti

Setup

To activate the kotti_settings add-on in your Kotti site, you need to add an entry to the kotti.configurators setting in your Paste Deploy config. If you don’t have a kotti.configurators option, add one. The line in your [app:main] (or [app:kotti], depending on how you setup Fanstatic) section could then look like this:

kotti.configurators = kotti_settings.kotti_configure

The add-on adds a new configuration page to save settings for your module or accross different modules. It adds a new submenupoint named “Settings” to the menupoint “Site Setup”. Every setting collection is presented in one tab. It is intended to use one tab for a module, but it is also possible to use multiple tabs if you have the need for a more extended structure.

You can choose between two modes to set up your settings. With the “dict mode” you have a very easy and straightforward option to set up the settings. If you need more advanced forms you can set up an own schema.

A setting tab is set up with with a dictionary. Here you define a name and a title for your tab, what are required. Optional arguments are success_message, either settings or schema, schema_factory and use_csrf_token.

Define your settings in a dictionary::

TestSettings = {
'name': 'test_settings',
'title': "Testsettings",
'description': "Some description for my settings",
'success_message': u"Successfully saved test settings.",
'settings': [
    {'type': 'String',
     'name': 'testsetting_1',
     'title': 'Test 1',
     'description': 'a test setting',
     'default': '', },
    {'type': 'Integer',
     'name': 'testsetting_2',
     'title': 'Test 2',
     'description': 'again a test setting',
     'default': 23, }]}

Define your settings with a schema::

class StringSchemaNode(colander.SchemaNode):
    name = 'a_string'
    title = 'hello'
    default = 'hello world'

class RangedIntSchemaNode(colander.SchemaNode):
    name = 'range_int'
    validator = colander.Range(0, 10)
    default = 5
    title = 'Ranged Int'

class TestSchema(colander.MappingSchema):
    string = StringSchemaNode(colander.String())
    ranged_int = RangedIntSchemaNode(colander.Int())

TestSettings = {
    'name': 'test_settings',
    'title': "Testsettings",
    'description': "Some description for my settings",
    'success_message': u"Successfully saved test settings.",
    'schema_factory': TestSchema
}

To get your configuration registered within kotti_settings add the settings in a populator in your add-on. Have a look to the Kotti documentation to get more informations for populators and to see an example.

Add your settings configuration within a populator, e.g. in a file named populate.py::

def populate():
    from kotti_settings.util import add_settings
    add_settings(TestSettings)

and add this to your configuration::

def kotti_configure(settings):
    settings['kotti.populators'] += ' my_addon.populate.populate'

or directly to your ini file::

kotti.populators = my_addon.populate.populate

To get your setting back into your code you use the following::

from kotti_settings.util import get_setting

first_test_setting = get_setting('test_setting_1')

Before and after the settings are saved events for handling the changes are fired. To subscribe to the events use something like:

from pyramid.events import subscriber
from kotti_settings.events import SettingsAfterSave

@subscriber(SettingsAfterSave)
def do_something_when_settings_saved(event):
    # Check if the settings for this module was saved.
    if not event.module == __package__:
        return
    my_fancy_thing()

Changelog

0.1b1(2013-03-29)

• Added event handling for callbacks before and after the settings are saved.

0.1a3(2013-03-13)

• Only take the module name itself into account for the setting name.

0.1a2(2013-03-11)

• Added util method get_setting as default way to get a setting.

0.1a1(2013-03-06)

• Initial release.