Merge "Update tosca lib to version 0.5"
[parser.git] / tosca2heat / tosca-parser / doc / source / usage.rst
1 =====
2 Usage
3 =====
4
5 The TOSCA Parser can be used as a library by any client program, for example,
6 OpenStack heat-translator uses it to translate TOSCA to Heat Orchestration
7 Template (HOT).
8
9 For an easy reference on how TOSCA Parser can be used programmatically or to
10 test that the a TOSCA template passes validation, refer to the tosca_parser.py
11 test program which is located at the root level of the project. Alternatively,
12 you can install 0.3.0 or higher PyPI release of TOSCA-Parser as available at the
13 https://pypi.python.org/pypi/tosca-parser and test use the parser via CLI
14 entry point as::
15     tosca-parser --template-file=toscaparser/tests/data/tosca_helloworld.yaml
16 The value to the --template-file is required to be a relative or an absolute path.