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

Uploaded Source

Built Distribution

django_configurations-0.4-py2.py3-none-any.whl (19.5 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for django-configurations-0.4.tar.gz
Algorithm Hash digest
SHA256 2c870c6c097e748f1b19e4ba374d81ee140fd07786d358e686846abf40fda37e
MD5 82903e9fec3d3a99efca094a76893c47
BLAKE2b-256 3be05db8f3ffc2b8590236918a3949662f7ef691aa567db0f35d001ad0ef48a5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_configurations-0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 93f8862f68b071d989d97fbe86531175e5ebb00549ba9c777222d0453b377e55
MD5 563878a093c66fb885a2e84e1221f0a3
BLAKE2b-256 af719035ff8d6c88d9a2b23dcb2dadf4c95b13ff9195c76ee9e6990ec693889a

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