Skip to main content

Utility to create yaml files from a template. Perfect for cloud-config or cloud-init creation.

Project description

Create a yaml file from a template and automatically embed local files.

Create builds for your cloud-init / cloud-config templates with ease!

This allows you to edit files and track in source control and wrap them in yaml files when needed. Supports compression to minimize yaml size (perfect to squeeze into startup scripts for AWS/EC2 instances).

File graphic by href=" - made by

Getting started

pip install yamlifier

cd testdata

yamlifier VARIABLE1="funny person"

Check out the generated.yaml file in the local folder. Use -f to overwrite existing file and –help for more information.

Template Syntax

#@ Comments like this will be removed from the generated file.
  - [ /example/ ]

  #@ 'local-content-path' will be replaced with content of local file.
  - path: /example/
    permissions: "0755"
    owner: "root"
    local-content-path: example_files/

  #@ Embed binary file as an example (could be an executable)
  - path: /example/small_logo.png
    permissions: "644"
    owner: "root"
    local-content-path: example_files/small_logo.png

  #@ Embed archive with multiple small files
  #@ 'local-content-tar-path' will be replaced with an embedded archive with all files in folder.
  - path: /example/archive.tgz
    permissions: "644"
    owner: "root"
    local-content-tar-path: example_files/subfolder

Building & Testing using Docker

Check out the git repository and from the yamlifier folder:

docker build -t yamlifier2 -f docker/python2.Dockerfile .

docker run -it -v $PWD:/code yamlifier2 bash


Based on the excellent ruamel.yaml library that allows manipulating yaml files while preserving comments and order.

Logo created with (image CC BY 3.0 license).

Source code and feedback

Fully open sourced with Apache License on including issue tracking.

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

yamlifier-1.0.3.tar.gz (9.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page