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 Dev(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=Dev

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=Dev

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', 'Dev')

    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', 'Dev')

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.3.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

django_configurations-0.3-py2.py3-none-any.whl (14.0 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for django-configurations-0.3.tar.gz
Algorithm Hash digest
SHA256 f539444f397a283b202d5ffaac4db845b625aa42c3c9f49f2bf814b0366bc056
MD5 623f9cad40b82234e059ddc27a59cf31
BLAKE2b-256 935c68816cb315cb894bb0f114e4e2fecdf58a2a6c51d16b8401eced3c0bcddf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_configurations-0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 841ce7b43a42bfa99a2c8d38aa86914408b2aaaa614bf532fd52c02aa5dac5ce
MD5 7e6671aa341b3b543b89faa9d9df66a6
BLAKE2b-256 5fa02f26a151d335585596d8bb92f09b8ff4ff40b137f663aba5dd13593ce280

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