search

rdkcentral / yaml_runner

This is a python library to be used in other scripts to allow YAML parsing and running of command-line commands defined within YAML files
Apache License 2.0
0 stars 0 forks source link

readme

Yaml Runner

Yaml Runner is a python library that provides a command-line interface to run commands stored in a yaml file.

Installatation

pip install git+https://github.com/rdkcentral/yaml_runner.git@master

Usage

The easiest way of using this library is to run it in a main function. See yaml_runner_run.py

This library can also be extended for more advanced usages. The easiest way is to inherit it in a class and extend it there.

Documentation

Here is an example of a yaml config that will run with yaml_runner test_config.yml. It has comments explaining how the sections are used. This config can be tested with the yaml_runner_run.py by running the following commands.

git clone https://github.com/rdkcentral/yaml_runner.git
cd yaml_runner/examples
./yaml_runner_run.py --config test_config.yml --help

Contributing

See contributing file: CONTRIBUTING.md

License

See license file: LICENSE