Skip to main content
Build Status Jazzband Codecov

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.

Check out the documentation for more complete examples.

Quickstart

Install django-configurations:

pip install django-configurations

Then subclass the included configurations.Configuration 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 Configuration

class Dev(Configuration):
    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 10 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.

Metadata

Release files for django-configurations 2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-configurations 2.0
File Size Uploaded
django-configurations-2.0.tar.gz 213.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for django-configurations 2.0
File Interpreter ABI Platform
django_configurations-2.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 229.0 kB

Release files / django-configurations-2.0.tar.gz

Download URL django-configurations-2.0.tar.gz
Size 213.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b4a4eb3ed631c2abbeb7008b5cc5d8d04b190df838e7b613731d728f674f3a2f
BLAKE2b-256 checksum
How to use checksums
6bc27b882cb05240938468818f3c6a532f8f0e650d7660215761f733c113fbbd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / django_configurations-2.0-py2.py3-none-any.whl

Download URL django_configurations-2.0-py2.py3-none-any.whl
Size 16.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
be47e25d070fd005cc8fbd6c913c9ec37e83d04686937afe18ca6c579b2cdedb
BLAKE2b-256 checksum
How to use checksums
67e1523610a7ccb9ed4b14ba63d0f6a192d5acb68f4b920259a8a57018f60112
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

2.5.1

2 release files

2.5

2 release files

2.4.2

2 release files

2.4.1

2 release files

2.4

2 release files

2.3.2

2 release files

2.3.1

2 release files

2.3

2 release files

2.2

2 release files

2.1

2 release files

This release

2.0 This release

2 release files

1.0

2 release files

0.8

2 release files

0.7

2 release files

0.6

2 release files

0.5.1

2 release files

0.5

2 release files

0.4

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3

2 release files

0.2.1

2 release files

0.2

2 release files

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page