django-constance-trbs 0.6.3

Fork

This is a fork of the original django-constance project which can be found at:

https://github.com/comoga/django-constance

Main reason for the fork is to have django-constance pip installable with Django 1.4+ compatibility fixes.

Hopefully we can have this fork merged back into the official repository as soon as possible.

Features

• Easily migrate your static settings to dynamic settings.

• Admin interface to edit the dynamic settings.

Installation

Install from PyPI the backend specific variant of django-constance:

For the (default) Redis backend:

pip install django-constance[redis]

For the database backend:

pip install django-constance[database]

Alternatively – if you’re sure that the dependencies are already installed – you can also run:

pip install django-constance-trbs

Or install the git development version using pip:

pip install -e git+git://github.com/trbs/django-constance-trbs#egg=django-constance-trbs

Configuration

Modify your settings.py. Add 'constance' to your INSTALLED_APPS, and move each key you want to turn dynamic into the CONSTANCE_CONFIG section, like this:

INSTALLED_APPS = (
    ...
    'constance',
)

CONSTANCE_CONFIG = {
    'MY_SETTINGS_KEY': {
        'default': 42,
        'help_text': 'the answer to everything'
    },
}

Here, 42 is the default value for the key MY_SETTINGS_KEY if it is not found in the backend. The help text will be shown in the admin.

See the Backends section how to setup the backend.

CONSTANCE_BACKEND = 'constance.backends.redisd.RedisBackend'

CONSTANCE_BACKEND = 'constance.backends.database.DatabaseBackend'

INSTALLED_APPS = (
    # other apps
    'constance.backends.database',
)

pip install django-picklefield

CONSTANCE_DATABASE_CACHE_BACKEND = 'memcached://127.0.0.1:11211/'

CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
        'LOCATION': '127.0.0.1:11211',
    }
}
CONSTANCE_DATABASE_CACHE_BACKEND = 'default'

CONSTANCE_DATABASE_PREFIX = 'constance:myproject:'

Usage

Constance can be used from your Python code and from your Django templates.

• Python

  Accessing the config variables is as easy as importing the config object and accessing the variables with attribute lookups:

  from constance import config
  
  # ...
  
  if config.MY_SETTINGS_KEY == 42:
      answer_the_question()

• Django templates

  To access the config object from your template, you can either pass the object to the template context:

  from django.shortcuts import render
  from constance import config
  
  def myview(request):
      return render(request, 'my_template.html', {'config': config})

  Or you can use the included config context processor.:

  TEMPLATE_CONTEXT_PROCESSORS = (
      # ...
      'constance.context_processors.config',
  )

  This will add the config instance to the context of any template rendered with a RequestContext.

  Then, in your template you can refer to the config values just as any other variable, e.g.:

  <h1>Welcome on {{ config.SITE_NAME }}</h1>
  {% if config.BETA_LAUNCHED %}
      Woohoo! Head over <a href="/sekrit/">here</a> to use the beta.
  {% else %}
      Sadly we haven't launched yet, click <a href="/newsletter/">here</a>
      to signup for our newletter.
  {% endif %}

Screenshots

Changelog