YAML Pipe

CLI utility for extracting YAML or JSON data.

PyPI: pipeyaml

Overview

You can use YAML Pipe as a CLI utility to access and/or search for the key of specific data nodes in a YAML or JSON file. This may help with data processing by not requiring you to, first, manually open and literally read the data file, then write code in your program to access certain keys to extract the data, and then run your program. YAML Pipe lets you grab the data, and then pipe it as input to another CLI tool or write it to a new file. It does not modify the original file.

Features

Usage:

$ yaml_pipe [-h/--help] [-q/--quiet]
<file> <enumerate, yaml, or json> <keys...>
[--search <key>] [--type <int, float, bool, bin, null, or timestamp>]

'yaml_pipe' takes three positional arguments, and four options. Provides autocomplete and abbreviation.

• HELP: [-h/--help] Usual help option.
• QUIET: [-q/--quiet] Option to turn off success messages printed to stderr.
• FILE: [file] Must include path to data file to parse as YAML (JSON is a subset of YAML).
• COMMAND: <enumerate, yaml, or json> Must select one of three commands:
  • ENUMERATE: Print the nodes at the current level. No nesting. Index sequences.
  • YAML: Output YAML data.
  • JSON: Output JSON string.
• KEYS: <keys ...> Optionally provide keys and/or indices as extra args to access nested nodes. Tab for autocomplete to list keys and indices.
• SEARCH: [--search <key>] Optionally search for a key. Must match exactly. Default data type is a string.
• TYPE: [--type <data_type>] Optionally select the data type of search keys that are not strings. Each choice correlates with a YAML data tag. Is an option for the search option.

Note

To ensure autocomplete with argcomplete works as intended, follow the order of arguments found here: $ yaml_pipe -q file command keys... --search key --type data_type

Download/Install

From source:

1. Clone the repo:

$ git clone https://github.com/skovranek/yaml_pipe

2. Change directories to the new 'yaml_pipe directory/', then run:

$ python3 -m pip install -e .
$ eval "$(register-python-argcomplete3 yaml_pipe)"

From PyPI:

$ pip install pipeyaml

NOTE: YAML Pipe is published on PyPI as 'pipeyaml', not 'yaml_pipe' or 'yamlpipe'.

Implement Library

There are a few different functions from this project you may want to import.

access_keys(node: Any, keys: List[str]) -> Any, bool:

Attempt to access value in a series of nested dicts and lists via list of keys and indices as strings. True/False for exists/not exists.

key_search(node: Any, key: str) -> Any, List[Any], bool:

Attempt to find specified dict key in a series of nested dicts and lists. Returned list is path of keys or indices to access value. True/False for found/not found.

print_keys(node: Any):

Prints the first layer of nodes. Keys are listed. Sequences are indexed. Nested values are printed inline flow style.

View the main function of Yaml Pipe for an example of how these functions are used.

Dependencies

The main dependencies of YAML Pipe are ruamel.yaml to parse YAML and JSON, argparse to parse CLI args, and argcomplete to autocomplete arguments and options.

View the requirements.txt file for the entire list of dependencies.

Testing

Manually tested with a zsh shell in the macOS terminal.

Contact

Questions, issues or suggestions: mattjskov at gmail.com

Contribute

Anyone is welcome to submit pull requests to the main branch.