Metadata-Version: 2.1
Name: ruamel.yaml.cmd
Version: 0.6.4
Summary: commandline utility to manipulate YAML files
Home-page: https://sourceforge.net/p/ruamel-yaml-cmd/code/ci/default/tree
Author: Anthon van der Neut
Author-email: a.van.der.neut@ruamel.eu
License: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Requires-Python: >=3
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: configobj
Requires-Dist: ruamel.yaml.convert (>=0.3)
Requires-Dist: ruamel.yaml (>=0.17.17)
Requires-Dist: ruamel.yaml.base
Requires-Dist: lz4
Provides-Extra: configobj
Requires-Dist: configobj ; extra == 'configobj'


ruamel.yaml.cmd
===============

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
