summaryrefslogtreecommitdiffstats
path: root/tosca2heat/tosca-parser/doc/source/usage.rst
diff options
context:
space:
mode:
authorshangxdy <shang.xiaodong@zte.com.cn>2016-04-07 14:08:49 -0400
committershangxdy <shang.xiaodong@zte.com.cn>2016-04-07 14:59:30 -0400
commitc8201c119ec686e79797721156767685fe848aca (patch)
treecce6aa15ded38d89c18a14b76c21f21e0b1a24f7 /tosca2heat/tosca-parser/doc/source/usage.rst
parent4e4c86a06d58b1816c074c7f9da4c58bbf10368c (diff)
Update tosca lib to version 0.5
Use tosca-parser and heat-translator to analyze to the basic nfv-tosca type definitions, and use simple tosca new feature such as policy, group and trigger, which are now supported by the latest version of tosca-parser and heat-translator. JIRA:PARSER-18 Change-Id: I797bcacbb5b32005d0aeb0f3f32851ac96e30f01 Signed--off-by: shangxdy <shang.xiaodong@zte.com.cn> Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
Diffstat (limited to 'tosca2heat/tosca-parser/doc/source/usage.rst')
-rw-r--r--tosca2heat/tosca-parser/doc/source/usage.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/tosca2heat/tosca-parser/doc/source/usage.rst b/tosca2heat/tosca-parser/doc/source/usage.rst
new file mode 100644
index 0000000..2b822a8
--- /dev/null
+++ b/tosca2heat/tosca-parser/doc/source/usage.rst
@@ -0,0 +1,16 @@
+=====
+Usage
+=====
+
+The TOSCA Parser can be used as a library by any client program, for example,
+OpenStack heat-translator uses it to translate TOSCA to Heat Orchestration
+Template (HOT).
+
+For an easy reference on how TOSCA Parser can be used programmatically or to
+test that the a TOSCA template passes validation, refer to the tosca_parser.py
+test program which is located at the root level of the project. Alternatively,
+you can install 0.3.0 or higher PyPI release of TOSCA-Parser as available at the
+https://pypi.python.org/pypi/tosca-parser and test use the parser via CLI
+entry point as::
+ tosca-parser --template-file=toscaparser/tests/data/tosca_helloworld.yaml
+The value to the --template-file is required to be a relative or an absolute path.