Skip to main content
pipeline status

YAML tool, a clone of the json.tool Python module for YAML.

This tool provides a simple command line interface to validate and pretty-print YAML documents while trying to preserve as much as possible from the original documents (like comments and anchors).

Usage

usage: yt [-h] [-i] [files ...]

YAML tool, a clone of the json.tool Python module for YAML.

This tool provides a simple command line interface to validate and pretty-print
YAML documents while trying to preserve as much as possible from the original
documents (like comments and anchors).

positional arguments:
  files           a YAML file to be validated or pretty-printed

optional arguments:
  -h, --help      show this help message and exit
  -i, --in-place  Perform the pretty-print in place, overwriting the existing files.

When enabling --in-place, all files are processed as input files.
When --in-place is not enabled and there are more then 2 files
passed, the last files is considered as the output file. If you
wish to pretty-print multiple files and output to standard out,
specify the last file as "-" .
Please note that specifying multiple input files will concatenate
them, resulting in a single file that has multiple documents.

pre-commit hook

YAML tool can be used as a pre-commit hook by adding the following to your .pre-commit-config.yaml file:

---
repos:
  - repo: https://git.shore.co.il/nimrod/yamltool.git
    rev: 0.1.2
    hooks:
      - id: yamltool

License

This software is licensed under the MIT license (see the LICENSE.txt file).

Author

Nimrod Adar, contact me or visit my website. Patches are welcome via git send-email. The repository is located at: https://git.shore.co.il/nimrod/.

Metadata

Release files for yamltool 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for yamltool 0.1.2
File Size Uploaded
yamltool-0.1.2.tar.gz 4.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for yamltool 0.1.2
File Interpreter ABI Platform
yamltool-0.1.2-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 8.9 kB

Release files / yamltool-0.1.2.tar.gz

Download URL yamltool-0.1.2.tar.gz
Size 4.0 kB
Tags Source
SHA-256 checksum
How to use checksums
9e86fc78a0e7b3f1067267efe6a21a8b19adb0b0340f82925e7fe9be4fd8b459
BLAKE2b-256 checksum
How to use checksums
c487325b35f0ea684edeea7873741f0d2709e7d4236ee4728482b5ef5cfe41e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.8.2 requests/2.26.0 setuptools/39.2.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.8

Release files / yamltool-0.1.2-py2.py3-none-any.whl

Download URL yamltool-0.1.2-py2.py3-none-any.whl
Size 5.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
9b9ff38895e0252a3fc3b8355f153609b1e6345ad7e5bb0fc2acc0f9a80ebb38
BLAKE2b-256 checksum
How to use checksums
fadf1b8eb9e36f0c87609add275d345bcd5a4e0e2d1cf055c2ac85d402756d90
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.8.2 requests/2.26.0 setuptools/39.2.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.8

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page