yamlsub 1.4.5

YAML configuration with environment variable substitution via .env files

yamlsub

YAML configuration with environment variable substitution.

Project Shields

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installing
• Usage

About

A wrapper around the python-dotenv and pyaml-env packages that loads environment variables from a .env file and substitutes them into a YAML configuration file.

Getting Started

Prerequisites

• Python 3.12+

Installing

Using pip:

pip install yamlsub

Using uv:

uv add yamlsub

To install directly from GitHub:

pip install yamlsub@git+https://github.com/willmorejg/yamlsub.git

Usage

Review the documentation for pyaml-env and python-dotenv for additional information on how to incorporate this project into other projects.

Given a .env file:

DB_HOST=localhost
DB_USER=root
DB_PASS=123456

And a config.yaml file:

database:
  host: !ENV ${DB_HOST}
  user: !ENV ${DB_USER}
  pass: !ENV ${DB_PASS}

Load and access the configuration:

from yamlsub.config import Config

cfg = Config(yaml_path='config.yaml', env_path='.env')

# Retrieve the full configuration
full_config = cfg.get_config()

# Retrieve a specific top-level key
database_config = cfg.get_config_key('database')
dbhost = database_config['host']
dbuser = database_config['user']
dbpass = database_config['pass']

print(f'Host: {dbhost}, User: {dbuser}, Pass: {dbpass}')