yaml-includes 0.1.0

A simple library for adding include directives to a YAML file.

yaml-includes

A lightweight Python library for composing YAML files with #!include directives.

Installation

Install it using pip:

pip install yaml-includes

or poetry:

poetry add yaml-includes

Overview

yaml-includes lets you split large YAML configurations into smaller, reusable fragments. Any line matching #!include <path> is replaced with the contents of the referenced file before parsing.

Include syntax

[indent]#!include relative/path/to/fragment.yaml

• Path is resolved relative to the file containing the directive.
• Leading whitespace before #!include is prepended to every line of the included content, preserving YAML nesting.
• Fragments can themselves contain #!include directives (recursive).

Example: indented include

# config.yaml
services:
  web:
    #!include web.yaml

# web.yaml
image: nginx
ports:
  - "80:80"

Result:

services:
  web:
    image: nginx
    ports:
      - "80:80"

Usage example

Loads a YAML file and resolves all #!include directives recursively.

import yaml
from yaml_include import load_text

document = yaml.safe_load(load_text("config.yaml"))

Development

# Install project dependencies
make install

# Run linter
make lint

# Run tests
make test

# Run tests with coverage
make test-with-cov

License

MIT