Contents

• 1   Getting started
  • 1.1   Setup
  • 1.2   Usage example
• 2   Guidelines
• 3   Supported settings files
• 4   Setting mode
• 5   Overriding settings
  • 5.1   Example:
• 6   Overriding partial settings

1   Getting started

1.1   Setup

pip install converge

1.2   Usage example

echo 'DEV' > .app_mode
echo 'SERVER_PORT = 8000' > default_settings.py
echo 'SERVER_PORT = 9000' > dev_settings.py
echo 'SERVER_PORT = 80' > prod_settings.py

Python

from converge import settings
print(settings.SERVER_PORT)

settings.get('VAR_THAT_DOESNT_EXIST')  # returns None

2   Guidelines

Settings files are usual Python files that can contain valid python code however here are some guidelines for user

• Use module variables for global application wide configuration

• Use UPPERCASE while naming settings variables

• For values prefer basic python datatypes usch as string, integer, tuples

• eg. SERVER_PORT = 1234

• Avoid logic

• Use simple classes for config sections

  class DB:
      HOST = 'db.example.com'
      PORT = 1234

• Use simple string operations to avoid repeatation

  BASE_DOMAIN = 'example.com'
  API_URL = 'api.' + BASE_DOMAIN``

3   Supported settings files

• Defaults: default_settings.py

• Mode

  • Production: prod_settings.py
  • Development: dev_settings.py
  • Test: test_settings.py
  • Staging: staging_settings.py

• Deployment specific: site_settings.py

4   Setting mode

Create a file .app_mode This file would have just one line specifying settings (and hence app’s) mode.

Valid values are

• PROD
• DEV
• TEST
• STAGING

Based on mode appropriate settings module would be used (if available)

5   Overriding settings

Defining module veriables in site_settings.py

5.1   Example:

default_settings.py

SERVER_PORT = 9999

site_settings.py

SERVER_PORT = 8888

6   Overriding partial settings

Example:

default_settings.py

class DB:
    HOST = 'db.example.com'
    PORT = 1234

site_settings.py

DB.PORT = 1111