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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-configurations-0.3.2.tar.gz
Algorithm Hash digest
SHA256 0ff04db776561887693989c597efaac307d8178dc92174c67effab3ab36fb321
MD5 dc428eb40a5e7b221a6966bfcf239973
BLAKE2b-256 2ec11cbff67c991c5559d2f75ad8876cbbb6be33bf654118b672cd287fb447c7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_configurations-0.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b9f69932590a241229d85d1f6591167998746c2d1ad315373271f3c937f64be8
MD5 3015a74b0894c67b5077589ea48ca9ca
BLAKE2b-256 1207ed6ad99e585546bad8e43866d7db71192f69c16220d2eb2de5a99c783304

See more details on using hashes here.

Provenance

Supported by

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