sys-vars 4.0.3

Access system variables in your code as native Python data types.

sys-vars

Access system variables in your code as native Python data types.

Usage

Requires Python 3.7+

Load system variables for used in applications as secrets, variables, and other related contexts as native Python data types. Searches for a file in SYS_VARS_PATH, falling back to os.enviorn, and finally checking the contents of a .env file located in SYS_VARS_PATH.

By default, SYS_VARS_PATH the Linux Docker secrets directory (/run/secrets). If an alternate path is required, set the value of SYS_VARS_PATH in your OS environment before app start.

import sys_vars


# Returns <class 'str'>
# Default values can be specified if the key is missing
sys_vars.get("HOST_ADDRESS", default="localhost")

# Returns <class 'bool'>
# Default values are supported for casting methods too
# Also treats "t", "true", "y", "yes" as True value
sys_vars.get_bool("DEBUG_MODE", default=False)

# Returns <class 'datetime.datetime'>
sys_vars.get_datetime("LAST_SYNC_RUN")

# Returns <class 'float'>
sys_vars.get_float("pi")

# Returns <class 'int'>
sys_vars.get_int("THE_MEANING_OF_LIFE")

# Returns <class 'dict'> or <class 'list'>
# Automatically decodes JSON strings into dictionaries/lists
sys_vars.get_json("CONFIGURED_TERMS")

# Returns <class 'pathlib.Path'>
sys_vars.get_path("CONFIG_PATH")

Building

1. Install Poetry
2. Run poetry install
3. Run poetry build
4. Tests can be run via the provided VS Code test runner config.

The resuting .whl file will be located at ./dist/sys_vars-<x.y.z>-py3-none-any.whl