ruamel.yaml.cmd


Nameruamel.yaml.cmd JSON
Version 0.6.5 PyPI version JSON
download
home_pagehttps://sourceforge.net/p/ruamel-yaml-cmd/code/ci/default/tree
Summarycommandline utility to manipulate YAML files
upload_time2023-07-11 18:51:30
maintainer
docs_urlNone
authorAnthon van der Neut
requires_python>=3
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
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

            

Raw data

            {
    "_id": null,
    "home_page": "https://sourceforge.net/p/ruamel-yaml-cmd/code/ci/default/tree",
    "name": "ruamel.yaml.cmd",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": "",
    "keywords": "",
    "author": "Anthon van der Neut",
    "author_email": "a.van.der.neut@ruamel.eu",
    "download_url": "https://files.pythonhosted.org/packages/67/8b/160574df45de97019d6c2f8804762622a90e4d6ad30436138fc0cca3b52f/ruamel.yaml.cmd-0.6.5.tar.gz",
    "platform": null,
    "description": "\nruamel.yaml.cmd\n===============\n\nThis package provides the ``yaml`` commandline utlity for converting to/from\nYAML and for manipulating YAML files\n\nBasic usage:\n------------\n\n- ``yaml round-trip <file_name>`` for basic roundtrip testing of YAML\n  files\n- ``yaml json <file_name>`` for conversion of JSON file(s) to a single\n  YAML block style document\n- ``yaml json --write <file_name>`` to convert JSON files to individual .yaml files.\n  This is essential for being able to comparing otherwise unreadable JSON files\n  (e.g. single line metadata.json files in .whl distributions)\n- ``yaml ini <file_name>`` for conversion of an INI/config file (ConfigObj\n  comment and nested sections supported) to a YAML block style document.\n  This requires ``configobj`` to be installed (``pip install ruamel.yaml.cmd[configobj]``)\n- ``yaml from-csv <file_name>`` for conversion CSV to a YAML\n  file to a a table in an HTML file.\n- ``yaml htmltable <file_name>`` for conversion of the basic structure in a YAML\n  file to a a table in an HTML file. The YAML file::\n\n    title:\n    - fruit\n    - legume\n    local:\n    - apple\n    - sprouts\n    import:\n    - orange\n    - broccoli\n\n  is converted into the table:\n\n  ====== ====== ========\n  title  fruit  legume\n  local  apple  sprouts\n  import orange broccoli\n  ====== ====== ========\n\n- ``yaml merge-expand <input> <output>`` expand merges in input YAML file (use - for stdin/out)\n\n- ``yaml pickle <input>`` load a pickle file (assuming your python version support the pickled data version).\n  If the object has a `to_yaml`` method it is registered and used for dumping. \n  If the object only has ``__getstate__`` or if ``--create-to-yaml`` is provided, a generic\n  ``to_yaml`` is added that will dump the dict as a mapping with a tag.\n   \n\nSee ``yaml --help`` for more information on the availble commands\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "commandline utility to manipulate YAML files",
    "version": "0.6.5",
    "project_urls": {
        "Homepage": "https://sourceforge.net/p/ruamel-yaml-cmd/code/ci/default/tree"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ae67544e8377d3ee635a3c85142b35cfe1c3b5c43d770400a843903608864063",
                "md5": "1502081f471877435e2c37e85db5ebed",
                "sha256": "0b9e3eeffac59e55f97abedc495a52a98e70161aaba07a4629c24adb016bde29"
            },
            "downloads": -1,
            "filename": "ruamel.yaml.cmd-0.6.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1502081f471877435e2c37e85db5ebed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 25422,
            "upload_time": "2023-07-11T18:51:32",
            "upload_time_iso_8601": "2023-07-11T18:51:32.634754Z",
            "url": "https://files.pythonhosted.org/packages/ae/67/544e8377d3ee635a3c85142b35cfe1c3b5c43d770400a843903608864063/ruamel.yaml.cmd-0.6.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "678b160574df45de97019d6c2f8804762622a90e4d6ad30436138fc0cca3b52f",
                "md5": "57f84053f3d8057a31c8ecb247f29770",
                "sha256": "49af59514cb87d7637d1186e31c9345c9947120a9ce49cf6975435aa7abd5aa8"
            },
            "downloads": -1,
            "filename": "ruamel.yaml.cmd-0.6.5.tar.gz",
            "has_sig": false,
            "md5_digest": "57f84053f3d8057a31c8ecb247f29770",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 32250,
            "upload_time": "2023-07-11T18:51:30",
            "upload_time_iso_8601": "2023-07-11T18:51:30.423912Z",
            "url": "https://files.pythonhosted.org/packages/67/8b/160574df45de97019d6c2f8804762622a90e4d6ad30436138fc0cca3b52f/ruamel.yaml.cmd-0.6.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-11 18:51:30",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ruamel.yaml.cmd"
}
        
Elapsed time: 0.08479s