Settings Manager

Settings Manager is designed to handle settings in python projects.

It makes the assumption you are working with environments and building applications.

The API consists of 2 functions load() to load the application settings and settings() to get access to a dict of the application settings.

Usage

You can put environment variables in your yaml config files and they will be loaded from the environment when the file is loaded. Calls to get environment variables like os.getenv() also work in python config files. Only json config files cannot contain environment variables.

You can also have base files i.e. base.py or base.yml or base.json and these will get loaded first. Then the current environment file, for isntance test.py will be loaded and override any variables which have the same name in base.py.

Deep Merging : currently the library does not do deep merges i.e. if you have nested hashes in your config files, only top level keys will be merged, not at a fine-grained deep level.

Here are some examples.

app:
  secret_key: ${SECRET_KEY}
  google_client_id: ${GOOGLE_CLIENT_ID}

SECRET_KEY = os.getenv('SECRET_KEY')
GOOGLE_CLIENT_ID = os.getenv('GOOGLE_CLIENT_ID')

JSON Config Files

Imagine you are working on a project with the following structure:

myapp/
  app.py
config/
  settings/
    test.json
    dev.json
    prod.json

from settings_manager.manager import SettingsManager

sm = SettingsManager(
        environment = 'test', 
        filetype = 'json'
        settings_dir = '/path/to/project/root/config/settings'    
)

sm.load()

# view settings dictionary
sm.settings() # { 'secret-key' : 'h390h2g3', ... }

YAML Config Files

Imagine you are working on a project with the following structure:

myapp/
  app.py
config/
  settings/
    test.yaml
    dev.yaml
    prod.yaml

Your yaml files can have .yml or .yaml file extensions.

from settings_manager.manager import SettingsManager

sm = SettingsManager(
        environment = 'test', 
        filetype = 'yaml'
        settings_dir = '/path/to/project/root/config/settings'    
)

sm.load()

# view settings dictionary
sm.settings() # { 'secret-key' : 'h390h2g3', ... }

Python Config Files

Imagine you are working on a project with the following structure:

myapp/
  app.py
config/
  settings/
    test.py
    dev.py
    prod.py

from settings_manager.manager import SettingsManager

sm = SettingsManager(
        environment = 'test', 
        filetype = 'python'
        settings_dir = '/path/to/project/root/config/settings'
        python_settings_module = 'config.settings'    
)

sm.load()

# view settings dictionary
sm.settings() # { 'secret-key' : 'h390h2g3', ... }

Todos:

1. Add deep merge ability