openstack/tosca-parser
Code Issues Proposed changes

Update documentation

Browse Source 
Update installation and usage doc.

Change-Id: I7cd55c999633cf63f25db631bf50c47b66421bca
Implements: blueprint tosca-shell-entry-support
This commit is contained in:
spzala 2015-12-01 02:03:05 -08:00
parent 17feff6ca5
commit cc65283d2e
2 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/installation.rst
View File

@ -2,4 +2,8 @@
Installation
============
TOSCA Parser is going to made available as a PyPi library.
You can clone the project and use it as below::
git clone https://github.com/openstack/tosca-parser
Tosca-Parser can be installed via PyPI package as well. Refer to https://pypi.python.org/pypi/tosca-parser for available packages.

12
doc/source/usage.rst
View File

@ -6,7 +6,11 @@ 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, refer
to the tosca_parser.py test program which is located at the root level of the
project.
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.