Skip to main content

Easily configure Python apps via environment variables, YAML, and AWS SSM Param Store.

Project description

Flex Config

triaxtec codecov Code style: black Generic badge MIT license

Configure your applications as easily as possible.

Main Features

Load config from wherever

  • Comes with built in support for loading from dicts, environment variables, JSON/YAML/TOML files, and AWS SSM Parameter Store.
  • Super easy to set up a custom source and load from anywhere.

Type conversion, validation, and hints via Pydantic

# "ConfigSchema" is pydantic's BaseModel renamed and re-exported for easier use 
from flex_config import ConfigSchema, construct_config

class Config(ConfigSchema):
    a_string: str
    an_int: int

# Raises ValidationError
my_bad_config = construct_config(Config, {"a_string": ["not", "a", "string"], "an_int": "seven"})

my_good_config = construct_config(Config, {"a_string": "my_string", "an_int": "7"})
assert isinstance(my_good_config.an_int, int)

Dynamic loading of config values

from pathlib import Path
from typing import Dict, Any

# "ConfigSchema" is pydantic's BaseModel renamed and re-exported for easier use 
from flex_config import ConfigSchema, construct_config, AWSSource, YAMLSource, EnvSource, ConfigSource

class Config(ConfigSchema):
    env: str
    my_thing: str

def get_ssm_params(config_so_far: Dict[str, Any]) -> ConfigSource:
    # env is set to live or dev via environment variables in the deployment environment
    env = config_so_far.get("env")
    if env == "local":  # Not a live deployment, my_thing is in a local yaml file
        return {}
    return AWSSource(f"my_app/{config_so_far['env']}")


my_config = construct_config(Config, [EnvSource("MY_APP_"), YAMLSource(Path("my_file.yaml")), get_ssm_params])

Installation

Basic install: poetry install flex_config With all optional dependencies (support for AWS SSM, YAML, and TOML): poetry install flex_config -E all

For a full tutorial and API docs, check out the hosted documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flex-config-2.1.0.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

flex_config-2.1.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file flex-config-2.1.0.tar.gz.

File metadata

  • Download URL: flex-config-2.1.0.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.8.15 Linux/5.15.0-1024-azure

File hashes

Hashes for flex-config-2.1.0.tar.gz
Algorithm Hash digest
SHA256 9c35349c24bb962f8d5458e17a60069c758f951a1c8a215fb05d9dc55cb9d5fd
MD5 4fcaaee84fa2c08497c26591c3d0879d
BLAKE2b-256 9ac78739b753775b406d5ba061f1a972ee2a6dc91624537e84684405c3594853

See more details on using hashes here.

File details

Details for the file flex_config-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: flex_config-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.8.15 Linux/5.15.0-1024-azure

File hashes

Hashes for flex_config-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 936e9c0ed647e082c7b3f3907f038eb7c4e8cae19489753b0db0d66e0e397575
MD5 911e3f33394cdccebd0a4e0ad358a11c
BLAKE2b-256 4dcca8f028dc3a75cb632223dac211a7db1cb1802d7c18b320f323726626aa35

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page