Metadata-Version: 2.1
Name: niet
Version: 0.2.1
Summary: Shell config file parser (json, yaml)
Home-page: https://github.com/gr0und-s3ct0r/niet/
Author: gr0und-s3ct0r
Author-email: contact@groundsector.com
License: UNKNOWN
Description: # niet
        
        Get data from yaml file directly in your shell
        
        ## Install
        
        ```sh
        $ pip install niet
        ```
        
        ## Usage
        
        ### With YAML file
        
        Consider the yaml file with the following content:
        ```yaml
        # /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:
        ```sh
        $ 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:
        ```json
        {
            "project": {
                "meta": {
                    "name": "my-project"
                }
            },
            "foo": "bar",
            "list-items": [
                "item1",
                "item2",
                "item3"
            ]
        }
        ```
        
        You can retrieve data from this file by using niet like this:
        ```sh
        $ 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:
        ```sh
        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:
        ```sh
        $ 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:
        ```yaml
        # tests/samples/sample.yaml
        project:
            meta:
                name: project-sample
                tags:
                  - example
                  - sample
                  - for
                  - testing
                  - purpose
        ```
        
        Retrieve the project name:
        ```sh
        $ niet tests/samples/sample.yaml project.meta.name
        project-sample
        ```
        
        Deal with list of items
        ```sh
        $ for el in $(niet tests/samples/sample.yaml project.meta.tags); do echo ${el}; done
        example
        sample
        for
        testing
        purpose
        ```
        
        CHANGES
        =======
        
        * 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>
        
        
Platform: UNKNOWN
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires: pbd
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: devel
