Skip to main content

A helper for organizing Django settings.

Project description

django-configurations
=====================

.. image:: https://secure.travis-ci.org/jezdez/django-configurations.png
:alt: Build Status
:target: https://travis-ci.org/jezdez/django-configurations

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:

.. code-block:: console

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.:

.. code-block:: python

# 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:

.. code-block:: console

export DJANGO_CONFIGURATION=Dev

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

.. code-block:: console

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:

.. code-block:: python
:emphasize-lines: 10

#!/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.:

.. code-block:: python
:emphasize-lines: 6

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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-configurations-0.8.tar.gz
Algorithm Hash digest
SHA256 4a7e193f4ce6d3a866c4c80c6dae0f02b491b165a417a1dbf20f38b59c8314ef
MD5 3ca3c5a0d78307ff304ecce3234c2822
BLAKE2b-256 18bc9033c3aa9e793b916afc98e00452a341e63936b8f831316d4bf4e3cea1ec

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_configurations-0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 44ad31980b4890c23157a5e14aeebcb73caf09ffd139faf72221acf98645c07e
MD5 d0f2c556bb55aca75ce0eeb5e4716e56
BLAKE2b-256 a9438b5eb72ce7c50fda748cbae3c3f4882b8d6c2a637a94aad9b5aca33ca557

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