Skip to main content

commandline utility to manipulate YAML files

Project description

This package provides the yaml commandline utlity for converting to/from YAML and for manipulating YAML files

Basic usage:

  • yaml round-trip <file_name> for basic roundtrip testing of YAML files

  • yaml json <file_name> for conversion of JSON file(s) to a single YAML block style document

  • yaml json --write <file_name> to convert JSON files to individual .yaml files. This is essential for being able to comparing otherwise unreadable JSON files (e.g. single line metadata.json files in .whl distributions)

  • yaml ini <file_name> for conversion of an INI/config file (ConfigObj comment and nested sections supported) to a YAML block style document. This requires configobj to be installed (pip install ruamel.yaml.cmd[configobj])

  • yaml from-csv <file_name> for conversion CSV to a YAML file to a a table in an HTML file.

  • yaml htmltable <file_name> for conversion of the basic structure in a YAML file to a a table in an HTML file. The YAML file:

    title:
    - fruit
    - legume
    local:
    - apple
    - sprouts
    import:
    - orange
    - broccoli

    is converted into the table:

    title

    fruit

    legume

    local

    apple

    sprouts

    import

    orange

    broccoli

  • yaml merge-expand <input> <output> expand merges in input YAML file (use - for stdin/out)

  • yaml pickle <input> load a pickle file (assuming your python version support the pickled data version). If the object has a to_yaml` method it is registered and used for dumping. If the object only has __getstate__ or if --create-to-yaml is provided, a generic to_yaml is added that will dump the dict as a mapping with a tag.

See yaml --help for more information on the availble commands

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

ruamel.yaml.cmd-0.6.5.tar.gz (32.2 kB view details)

Uploaded Source

Built Distribution

ruamel.yaml.cmd-0.6.5-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

Details for the file ruamel.yaml.cmd-0.6.5.tar.gz.

File metadata

  • Download URL: ruamel.yaml.cmd-0.6.5.tar.gz
  • Upload date:
  • Size: 32.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.5

File hashes

Hashes for ruamel.yaml.cmd-0.6.5.tar.gz
Algorithm Hash digest
SHA256 49af59514cb87d7637d1186e31c9345c9947120a9ce49cf6975435aa7abd5aa8
MD5 57f84053f3d8057a31c8ecb247f29770
BLAKE2b-256 678b160574df45de97019d6c2f8804762622a90e4d6ad30436138fc0cca3b52f

See more details on using hashes here.

File details

Details for the file ruamel.yaml.cmd-0.6.5-py3-none-any.whl.

File metadata

File hashes

Hashes for ruamel.yaml.cmd-0.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0b9e3eeffac59e55f97abedc495a52a98e70161aaba07a4629c24adb016bde29
MD5 1502081f471877435e2c37e85db5ebed
BLAKE2b-256 ae67544e8377d3ee635a3c85142b35cfe1c3b5c43d770400a843903608864063

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page