niet

Get data from yaml file directly in your shell

Install

$ pip install niet

Usage

With YAML file

Consider the yaml file with the following content:

# /path/to/your/file.yaml
project:
    meta:
        name: my-project
    foo: bar
    list-items:
        - item1
        - item2
        - item3

You can retrieve data from this file by using niet like this:

$ niet /path/to/your/file.yaml "project.meta.name"
my-project
$ niet /path/to/your/file.yaml "project.foo"
bar
$ niet /path/to/your/file.yaml "project.list-items"
item1 item2 item3
$ # assign return value to shell variable
$ NAME=$(niet /path/to/your/file.yaml "project.meta.name")
$ echo $NAME
my-project

With JSON file

Consider the json file with the following content:

{
    "project": {
        "meta": {
            "name": "my-project"
        }
    },
    "foo": "bar",
    "list-items": [
        "item1",
        "item2",
        "item3"
    ]
}

You can retrieve data from this file by using niet like this:

$ niet /path/to/your/file.json "project.meta.name"
my-project
$ niet /path/to/your/file.json "project.foo"
bar
$ niet /path/to/your/file.json "project.list-items"
item1 item2 item3
$ # assign return value to shell variable
$ NAME=$(niet /path/to/your/file.json "project.meta.name")
$ echo $NAME
my-project

Deal with errors

When your JSON file content are not valid niet display an error and exit with return code 1

You can easily protect your script like this:

PROJECT_NAME=$(niet your-file.yaml project.meta.name)
if [ "$?" = "1" ]; then
    echo "Error occur ${PROJECT_NAME}"
else
    echo "Project name: ${PROJECT_NAME}"
fi

Tips

You can pass your search with or without quotes like this:

$ niet your-file.yaml project.meta.name
$ niet your-file.yaml "project.meta.name"

Tests

You can try niet by using the samples provided with the project sources code.

Sample example:

# tests/samples/sample.yaml
project:
    meta:
        name: project-sample
        tags:
          - example
          - sample
          - for
          - testing
          - purpose

Retrieve the project name:

$ niet tests/samples/sample.yaml project.meta.name
project-sample

Deal with list of items

$ for el in $(niet tests/samples/sample.yaml project.meta.tags); do echo ${el}; done
example
sample
for
testing
purpose

CHANGES

0.2.1

• fix bad behavior on element not found
• fix documentation examples
• remove tick from list results
• using readme at markdown format on pypi

0.1.0

• First commit

Hervé Beraud herveberaud.pro@gmail.com