Skip to main content

This Django app allows you to export certain settings to your templates.

Project description

PyPi Build Status of the master branch Coverage

Often it is needed to make some of your Django project’s settings accessible from within templates. This app provides a simple mechanism for doing just that.

Principles:

  • Explicit is better than implicit: Only explicitly listed settings keys are exported to templates.
  • Errors should never pass silently: Accessing an undefined or unexported setting key from a template results in an exception.

Tested on Python 2.7+, Django 1.5+.

Installation

$ pip install django-settings-export

Add 'django_settings_export.settings_export' to template context processor list in your settings.py:

Django 1.8 and newer:

TEMPLATES = [
    {
        # …
        'OPTIONS': {
            'context_processors': [
                # …
                'django_settings_export.settings_export',
            ],
        },
    },
]

Django older than 1.8:

TEMPLATE_CONTEXT_PROCESSORS = [
    # [...]
    'django_settings_export.settings_export',
]

Usage

All settings that should be made accessible from templates need to be explicitly listed in settings.SETTINGS_EXPORT:

# settings.py

DEBUG = True
GA_ID = 'UA-00000-0'

SETTINGS_EXPORT = [
    'DEBUG',
    'GA_ID',
]

Now you can access those exported settings from your templates via settings.<KEY>:

{% if not settings.DEBUG %}
    <script>ga('create', '{{ settings.GA_ID }}', 'auto');</script>
{% endif %}

Exceptions:

  • Listing an undefined setting key in SETTINGS_EXPORT results in an UndefinedSettingError.
  • Accessing a unexported setting key on the settings object in a template results in an UnexportedSettingError.

See also the bundled demo app.

Development

$ cd demo

# Run demo
$ python manage.py runserver

# Run tests on current Python
$ python manage.py test

# Run tests on all Pythons
$ tox

Licence

BSD. See LICENCE for more details.

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 django-settings-export, version 1.0.6
Filename, size File type Python version Upload date Hashes
Filename, size django_settings_export-1.0.6-py2-none-any.whl (5.3 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size django-settings-export-1.0.6.tar.gz (4.0 kB) File type Source Python version None Upload date Hashes View

Supported by

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