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.
Check out the `documentation`__ for more complete examples.
.. __: http://django-configurations.readthedocs.org/en/latest/
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.
=====================
.. 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.
Check out the `documentation`__ for more complete examples.
.. __: http://django-configurations.readthedocs.org/en/latest/
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django-configurations-x-0.8.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b9f2896099f45f9877626d0d78c7f1f66c3512649613d5e784c03a4f82d27de |
|
MD5 | 55e98b765dae161b44c74fcfb2e317a2 |
|
BLAKE2b-256 | 00dd3c2ca85fa58060bc937084ab290be9629c7479be9a745840e07e4df74258 |
Close
Hashes for django_configurations_x-0.8.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2c68d4322c3d231fa75d5e714d4995e89be378c8704ae790af4765b7e9a1b02 |
|
MD5 | e5a10db168815c0fe00fd9953503531e |
|
BLAKE2b-256 | 7a7e0fc9ef045ceb4892b6a207c9202cce386e6762d078336b7118b01eda2ef9 |