Marten

Stupid simple Python configuration environments

Inspired by node config, if you've used it before, Marten will feel familiar with a couple of extras

Tested with Python 2.7 and 3.5

---

Install

> pip install marten

Quick Start

Marten provides several ways to load configurations, the simplest being the bundled config automatically created by Marten using files found in the .marten/ directory

The bundled config is available in Python at marten.config, and can be accessed like a normal dictionary

> mkdir .marten
> echo "EXAMPLE = True" > .marten/default.py
> python
>>> from marten import config
>>> config['EXAMPLE']
True

Configurations can also manually be created using the classes in the marten.configurations module

> python
>>> from marten.configurations import PythonConfiguration
>>> config = PythonConfiguration('.marten/default.py')
>>> config['EXAMPLE']
True

Marten also comes bundled with a tiny marten cli that outputs the bundled marten.config in JSON format

> marten
{
    "EXAMPLE": true
}

Features

Swappable Configurations

The bundled config can easily be swapped between different configuration environments using the MARTEN_ENV environment variable

The MARTEN_ENV variable defaults to default

> marten
{
    "EXAMPLE": true
}
> echo "SECOND_FILE = 'Environment number two'" > .marten/two.py
> echo "THIRD_FILE = 'This is a third environment'" > .marten/three.py
> MARTEN_ENV=two marten
{
    "SECOND_FILE": "Environment number two"
}
> MARTEN_ENV=three marten
{
    "THIRD_FILE": "This is a third environment"
}

Full Python

The configuration files are not parsed, but are imported as Python modules

Only capitalized variables not starting with underscores are read into the configuration, allowing other variables to be used for logic and setup

> echo "a = 1; _B = 2; FULL_PYTHON = a + _B == 3" > .marten/python.py
> MARTEN_ENV=python marten
{
    "FULL_PYTHON": true
}

Multiple File Formats

Marten is not limited to Python files

> echo '{"KEY": "value"}' > .marten/formats.json
> MARTEN_ENV=formats marten
{
    "KEY": "value"
}

Current supported formats:

• Python
• JSON
• YAML

Nested Environment Variable Expansion

Strings in values with the format $VAR or ${VAR} are automatically expanded as environment variables

Variables that are unset are left unmodified

> echo '{"REPLACED1": "This ${ENV}", "REPLACED2": "Second $ENV", "IGNORED": "${MISSING}"}' > .marten/environ.json
> MARTEN_ENV=environ ENV=value marten
{
    "IGNORED": "${MISSING}",
    "REPLACED1": "This value",
    "REPLACED2": "Second value"
}

Merge Multiple Files

Since Marten operates on filename and extension separately, two files with the same name but different extensions are merged together in the order they are loaded

> echo 'PYTHON = True' > .marten/merge.py
> echo '{"JSON": true}' > .marten/merge.json
> echo 'YAML: true' > .marten/merge.yaml
> MARTEN_ENV=merge marten
{
    "JSON": true,
    "PYTHON": true,
    "YAML": true
}

License

Available under the MIT license

See LICENSE for more details