Skip to main content

A helper for organizing Django settings.

Project description

Jazzband Build Status Test coverage status Documentation status Supported Python versions Supported Django versions

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

or, alternatively, if you want to use URL-based values:

pip install django-configurations[cache,database,email,search]

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, wsgi.py or asgi.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.

Or if you are not serving your app via WSGI but ASGI instead, you need to modify your asgi.py file too.:

import os

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

from configurations.asgi import get_asgi_application

application = get_asgi_application()

That’s it! You can now use your project with manage.py and your favorite WSGI/ASGI 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-2.3.2.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

django_configurations-2.3.2-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-configurations-2.3.2.tar.gz
  • Upload date:
  • Size: 42.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for django-configurations-2.3.2.tar.gz
Algorithm Hash digest
SHA256 bd1a77a60735839b7d105912cc3977735fa005ea06544c632fbd322d1e021677
MD5 54b8f7ad39dcbac2387f3c56a81cb68f
BLAKE2b-256 9b9582cc334afd1993ce483ce43e90d3bf77c89e5de8312842f4b50da426d0b2

See more details on using hashes here.

Provenance

File details

Details for the file django_configurations-2.3.2-py3-none-any.whl.

File metadata

  • Download URL: django_configurations-2.3.2-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for django_configurations-2.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c0363b0111df6536442186d0f23d12138390eaa9f4f97ce46950ee78856a46c9
MD5 c5c54ddfd1e51046f7aa37c310acccd6
BLAKE2b-256 a8325bc7b54bf56c70127642181930161ca0adf72f530dee39bb9c6acac40dd9

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