yamlator 0.0.1

Yamlator is a CLI tool that allows a YAML file to be validated using a lightweight schema language

Yamlator

Yamlator is a CLI tool that allows a YAML file to be validated against a lightweight schema that defines the expected structure. When executed, the YAML data structure is compared against the rules to validate that the required keys and data types are present. Once validated, a list of violations will be returned that can be used to amend the file.

Installing the package

The Yamlator package can be installed from PyPi with:

pip install yamlator

Creating a basic schema

Schemas in Yamlator are comprised of rules, rulesets and enums in a .ys file.

In the Yamlator schema file, the entry point is defined in a schema block, which is the required as a minimum to valiate a file. For example:

schema {
    name str
    age int
}

Once this block has been placed into a Yamlator schema file, it can be used to validate the following YAML file:

name: Name
age: 100

With Yamlator, more complex structures can be defined as rulesets to validate nested structures. For example:

ruleset Employee {
    firstName str
    lastName str
    roles list(str) optional
}

schema {
    employees list(Employee)
}

This can then be used to validate the following YAML data:

employees:
    - firstName: employee
      lastName: one
      departments:
        - manager
    - firstName: employee
      lastName: two
      departments:
        - engineer
        - manager
    - firstName: employee
      lastName: three

More information on the different components that make up a schema can be found in the schema components document.

Some examples of a schema file with a YAML file can be found in the examples directory

How to run the CLI

Assuming you have a YAML and Yamlator files, the CLI can be executed with:

yamlator <path-to-yaml-file> -s <path-to-yamlator-schema>

Where <path-to-yaml-file> is replaced with the path to your YAML file and <path-to-yamlator-schema> is the path to the schema, which has the extension .ys.

The first argument for the CLI is always the path to the YAML file.

Flag	Alias	Description	Is Required
--schema	-s	The schema that will be used to validate the YAML file	True
--output	-o	Defines the format that will be displayed for the violations. Support values are table or json. Defaults to table if not specified.	False

To see the help options for the CLI, run yamlator -h or yamlator --help

Setting up the development environment

For instructions on how to set up the development environment, read the setting up the environment document.