Skip to main content

A helper for organizing Django settings.

Project description

Build Status

django-configurations eases Django project configuration by relying on the composability of Python classes. It extends the notion of Django’s module based settings loading with well established object oriented programming patterns.

Quickstart

Install django-configurations:

pip install django-configurations

Then subclass the included configurations.Settings class in your project’s settings.py or any other module you’re using to store the settings constants, e.g.:

# mysite/settings.py

from configurations import Settings

class MySiteSettings(Settings):
    DEBUG = True

Set the DJANGO_CONFIGURATION environment variable to the name of the class you just created, e.g. in bash:

export DJANGO_CONFIGURATION=MySiteSettings

and the DJANGO_SETTINGS_MODULE environment variable to the module import path as usual, e.g. in bash:

export DJANGO_SETTINGS_MODULE=mysite.settings

Alternatively supply the --configuration option when using Django management commands along the lines of Django’s default --settings command line option, e.g.:

python manage.py runserver --settings=mysite.settings --configuration=MySiteSettings

To enable Django to use your configuration you now have to modify your manage.py or wsgi.py script to use django-configurations’s versions of the appropriate starter functions, e.g. a typical manage.py using django-configurations would look like this:

#!/usr/bin/env python

import os
import sys

if __name__ == "__main__":
    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings')
    os.environ.setdefault('DJANGO_CONFIGURATION', 'MySiteSettings')

    from configurations.management import execute_from_command_line

    execute_from_command_line(sys.argv)

Notice in line 9 we don’t use the common tool django.core.management.execute_from_command_line but instead configurations.management.execute_from_command_line.

The same applies to your wsgi.py file, e.g.:

import os

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings')
os.environ.setdefault('DJANGO_CONFIGURATION', 'MySiteSettings')

from configurations.wsgi import get_wsgi_application

application = get_wsgi_application()

Here we don’t use the default django.core.wsgi.get_wsgi_application function but instead configurations.wsgi.get_wsgi_application.

That’s it! You can now use your project with manage.py and your favorite WSGI enabled server.

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

django-configurations-0.2.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

django_configurations-0.2-py2.py3-none-any.whl (10.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django-configurations-0.2.tar.gz.

File metadata

File hashes

Hashes for django-configurations-0.2.tar.gz
Algorithm Hash digest
SHA256 7167b28bb56b5766713d9e666d37ee66b8d6e159e9a5d2aa19adcb6eb54d6eb9
MD5 24c13e378d1fcfdeb435919bda88361f
BLAKE2b-256 e8c03b1909f28148b1afe0bdb204a28a04b76c787f8320347f13ad57cfd09f32

See more details on using hashes here.

File details

Details for the file django_configurations-0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_configurations-0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 57c939148c9a182240ba59030037bfa6b9159955a34d47d03fa9483b4c3605dc
MD5 ab2448350cdeaf858944224047b95945
BLAKE2b-256 8acb16fde36ad40bc39c23d6e4037d5a1748ef668ffcff52e7446fe64de5c3f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page