Skip to content

Ecosystem

ruamel.yaml

Yamkix relies on the awesome ruamel.yaml package.

yamllint

yamllint is the natural linter neighbor of a formatter like yamkix: it checks YAML where yamkix rewrites it. See Comparison with yamllint for a detailed analysis of how yamkix default output relates to yamllint's relaxed preset.

kubesplit

  • kubesplit (from the same author as yamkix) uses yamkix under the hood to format the yaml descriptors that it generates.
  • We try to make sure kubesplit compatible with yamkix. Please create issues in either yamkix github repo or kubesplit github repo if you think we broke something.

Using yamkix API

  • In the future, we will try to not generate breaking changes in the functions and classes that we consider public, i.e. the ones declared in the yamkix root init.py.
  • if you think we did break the API contract, please raise an issue.
  • if you are using something else that what is declared in the root package, please get in touch so that we know about it and see what we can do for you.