ytools3

Library for validating yaml files against schema and selectively dumping nodes from yaml (or json) documents in yaml or json format.

This is a port of the Python 2-only ytools ( https://github.com/yaccob/ytools ) to Python 3.

Docs

Documentation Build Status Docs Check Status

Tests

Linux Test Status Windows Test Status macOS Test Status Coverage

PyPI

PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel

Activity

GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads

QA

CodeFactor Grade Flake8 Status mypy status

Other

License GitHub top language Requirements Status

Features

  • Output yaml as json or python

  • Output json as yaml or python (provided that there are no duplicate mapping entry in the json source)

  • Extract particular nodes from yaml and json files.

    • If yaml is used as output format (default) the output is a valid yaml document.

  • Validate yaml and json documents.

    • The json-schema can be provided in yaml format as well, which improves readability and writability.

  • Preserve order of mapping-keys in yaml and json output.

  • Multi-document support

    • Multiple input files

      • … as well as multiple yaml documents within a file

      • … and a combination of both

Installation

python3 -m pip install ytools3 --user

Documentation

View the Function Index or browse the Source Code.

Browse the GitHub Repository