Installation¶

$ pip install django-flexisettings

No need to declare flexisettings in INSTALLED_APPS.

Configuration¶

[...]
if __name__ == "__main__":
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "flexisettings.settings")
    os.environ.setdefault("FLEXI_WRAPPED_MODULE", "myproject.settings")
[...]

[...]
import os

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "flexisettings.settings")
os.environ.setdefault("FLEXI_WRAPPED_MODULE", "myproject.settings")
[...]

$ cd /path/to/myproject
$ /path/to/venv/bin/python gunicorn --workers=42 myproject.wsgi:application

CONFIG = {
    'python': '/path/to/venv/bin/python',
    'working_dir': '/path/to/myproject',
    'user': 'www-data',
    'group': 'www-data',
    'args': (
        'myproject.wsgi:application',
    ),
}

Settings options¶

Settings options default values are set to ensure consistency with django settings behavior. Most of the smartness, unicorns and rainbows are not enabled by default.

Example configuration¶

• edit env.py to set the working environment, let’s use prod here:

  $ cat myproject/env.py
  # environment declaration
  FLEXI_RUN_ENV = 'prod'
  

• edit security.py to set the SECRET_KEY value:

  $ grep SECRET_KEY myproject/security.py
  SECRET_KEY = 'alongandcomplexsecretstring'
  

• set security variables in security_prod.py to be used in any settings file:

  $ grep DEFAULTDB myproject/security_prod.py
  DEFAULTDB_NAME = 'dbname'
  DEFAULTDB_USER = 'dbuser'
  DEFAULTDB_PWD = 'secret'
  

• edit settings_prod.py to override generic settings like DATABASES, MEDIA_ROOT, TIME_ZONE:

  $ cat myproject/settings/settings_prod.py
  [...]
  DATABASES = {
      'default': {
          'ENGINE': 'django.db.backends.postgresql_psycopg2',
          'NAME': DEFAULTDB_NAME,
          'USER': DEFAULTDB_USER,
          'PASSWORD': DEFAULTDB_PWD,
          'HOST': '',
          'PORT': '',
      }
  }
  [...]
  

Layout¶

myproject/__init__.py
          env.py
          security.py
          security_FLEXI_RUN_ENV.py
          settings.py
          settings_FLEXI_RUN_ENV.py

• env.py has a single variable FLEXI_RUN_ENV that defines a running environment. This variable is then used to call different profiles of configuration depending on the running environment like dev, stage and prod. The FLEXI_RUN_ENV variable can also be set by environment, the environment takes precedence over env.py. Example:

  $ export FLEXI_RUN_ENV='dev'; python manage.py runserver
  

• security.py holds all the common security variables for the project, probably a good place for SECRET_KEY.

• security_FLEXI_RUN_ENV specific environment security variables, dedicated database passwords should go there. Setting defined here will override settings defined in security.py.

• settings.py the classic settings file found in all django projects.

• settings_FLEXI_RUN_ENV.py gathers local settings for a given running environment, settings defined here will override settings defined in settings.py.

Loading order¶

The modules are loaded in the following order:

1. myproject/env.py
2. myproject/security.py
3. myproject/security_FLEXI_RUN_ENV.py
4. myproject/settings.py
5. myproject/settings_FLEXI_RUN_ENV.py

If the FLEXI_RUN_ENV variable is false in python, the only settings files read are security.py and settings.py.

Security files¶

A very simple way to make sure that passwords are not pushed in your VCS is to exclude any file matching myproject/security*. It would also be a good idea to reduce the access to such files by removing read rights for users other than the one running django.

VCS¶

Files that should not be pushed to your VCS are:

• env.py : to allow for multiple environments to run at the same time. If you’re using git, you can add myproject/env.py in .gitignore.
• any security file : repeat after me, any security data in your VCS is a bad idea. If you’re using git you can add myproject/security*.py in .gitignore.

LICENSE¶

Verbatim of LICENSE file:

Copyright (c) 2012, Heatwave fashion Ltd. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the Heatwave fashion Ltd. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.