Dynamic runtime settings and configuration for Django sites
Project description
An application for managing site configuration through normal Django forms, and thus through the admin site.
Yay, I’ve made another app to abuse contrib.admin.
Release |
Status |
---|---|
stable (0.3.0) |
|
master |
Pre-requisites
The following versions are tested:
Python 2.7, 3.3, or 3.4
Django 1.7 or 1.8
Installation
First up, you need to install it (via pip as usual):
pip install django-stagesetting==0.3.0
Once that’s downloaded, add the package to your INSTALLED_APPS in your settings:
INSTALLED_APPS = ( # ... 'stagesetting', # ... )
do a migrate:
python manage.py migrate stagesetting
Add a STAGESETTINGS dictionary to your project’s settings:
STAGESETTINGS = { 'SETTING_NAME': '...', 'ANOTHER_SETTING_NAME': '...', }
The setting collection name is the dictionary key, so must be unique.
Writing settings
Settings may be created in a number of ways, the simplest of which is to provide a dictionary as the value:
STAGESETTINGS = { 'MY_SETTING': { 'an_example-datetime': datetime.today(), 'a_date': date.today(), 'time_now': time(4, 23), 'boolean_field': False, 'plain_text': 'char field', 'decimal': Decimal('3.25'), 'float': 2.3, } }
where possible, this will auto-generate a Form class for you, choosing sensible defaults for the field variants where possible.
The other option is for the value to be a list or a tuple, where the first item represents a form (either a dictionary as above, OR the dotted.path.to.a.Form.Class if you need custom validation) and the second, optional item is the default data. The following should all be valid:
STAGESETTINGS = { 'AUTO_GENERATED': [{ 'datetime': datetime.today(), }], 'IMPORT_A_FORM': ['myapp.forms.MyForm'], 'IMPORT_WITH_DEFAULT': ['myapp.forms.MyForm', {'default': 'data'}], 'AUTO_GENERATED_WITH_OTHER_DEFAULTS': [{ 'datetime': datetime.today(), }, {'default': 'data'}], }
A simple configuration form (for the dotted.path.Format) might look like:
from django.core.exceptions import ValidationError from django.forms import Form, DateField class DateForm(Form): start = DateField() end = DateField() def clean(self): cd = self.cleaned_data if 'start' in cd and 'end' in cd and cd['start'] > cd['end']: raise ValidationError("Start date cannot be after end date") return cd
As you can see, it really is just a normal Form. Internally, this form’s cleaned_data will be converted into JSON before being saved to the database. It will get re-converted to proper Python values when pulled out of the database, by going through the given Form class’s validation again, including converting to rich values like model instances.
Python types which can be detected
When detecting a dictionary as the value and auto-generating a form, the following translations will be applied:
None becomes NullBooleanField
datetime.datetime becomes DateTimeField
datetime.date becomes DateField
datetime.time becomes TimeField
datetime.timedelta becomes DurationField
decimal.Decimal becomes DecimalField
float becomes FloatField
True or False become BooleanField
int becomes IntegerField
uuid.UUID becomes UUIDField or CharField, depending on the Django version
list and tuple become MultipleChoiceField
collections.OrderedDict, set, frozenset, and dict become ChoiceField
models.Model instances become ModelChoiceField
models.QuerySet becomes ModelMultipleChoiceField
strings become one of the following, depending on what checks they pass:
Usage in code
The best way to access the settings in your views is to include stagesetting.middleware.ApplyRuntimeSettings in your MIDDLEWARE_CLASSES which will ensure there is a request.stagesettings variable which can be used like so:
def myview(request): how_many_form_data = request.stagesetting.LIST_PER_PAGE allow_empty_form_data = request.stagesetting['ALLOW_EMPTY']
each setting will be a dictionary of the Form values, either the default ones or those changed in the database.
Usage in templates
If you’ve already got request in your template, obviously you can continue to use request.stagesettings if the middleware is wired up.
If you don’t have request, or you’re not using the middleware, stagesetting.context_processors.runtime_settings provides a STAGESETTING template variable which contains the exact same data.
Usage outside of a request
If you don’t have the middleware, or are in a part of the code which doesn’t have a request, you can use the wrapper object directly:
from stagesetting.models import RuntimeSettingWrapper def my_signal_handler(sender, instance, **kwargs): live_settings = RuntimeSettingWrapper() data = live_settings.LIST_PER_PAGE
Try to keep a single RuntimeSettingWrapper around for as long as possible, rather than creating a new instance everywhere, as the object must fetch the available settings from the database the first time it needs them. It caches them for it’s lifetime thereafter.
License
django-stagesetting 0.3.0 is available under the terms of the Simplified BSD License (alternatively known as the FreeBSD License, or the 2-clause License):
Copyright (c) 2015, Keryn Knight All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the FreeBSD Project.
Change log
0.3.0
Added ability to auto-generate forms for configuration values which are dictionaries.
0.2.0
Initial release.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-stagesetting-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a901765fee8299a05e645610ab1d3913ddc3b87808a584adecae33e68a5227df |
|
MD5 | 68097d0c44ad3180a195e7ba4533ac4b |
|
BLAKE2b-256 | 53a1f6a92dbffbd35bccc1ea46ee614256b77840fa6ff00f40f2f349bbe8f08c |
Hashes for django_stagesetting-0.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbb1d130a7b83fb7245b57377c7afefee2ccfa47e21bc53fef70f159df7ace03 |
|
MD5 | be242d9b385834d8c08217865b1d431e |
|
BLAKE2b-256 | b2932105f215d47ffe9d0d8b279135db4ba340b8b3e03d384b97fc2feec2e091 |