diff options
author | shangxdy <shang.xiaodong@zte.com.cn> | 2017-03-09 19:29:34 +0800 |
---|---|---|
committer | shangxdy <shang.xiaodong@zte.com.cn> | 2017-03-09 20:03:51 +0800 |
commit | d10f22decf8e511ce9421d707c56bed0d26c848d (patch) | |
tree | 10a57dc01eb3ce2a39c4103a0c1856763bce3112 /tosca2heat/tosca-parser | |
parent | c09ba66cc51c4db17503f79c05ea0b0cd0626596 (diff) |
Fix docs bug
Fix docs bug when install parser or run tox tools
JIRA:PARSER-122
Change-Id: I247afee0b81e64ea691b061ab600e20ce55849c7
Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
Diffstat (limited to 'tosca2heat/tosca-parser')
-rw-r--r-- | tosca2heat/tosca-parser/README.md | 54 | ||||
-rw-r--r-- | tosca2heat/tosca-parser/setup.cfg | 10 |
2 files changed, 55 insertions, 9 deletions
diff --git a/tosca2heat/tosca-parser/README.md b/tosca2heat/tosca-parser/README.md new file mode 100644 index 0000000..0f94072 --- /dev/null +++ b/tosca2heat/tosca-parser/README.md @@ -0,0 +1,54 @@ +======================== +Team and repository tags +======================== + +.. image:: http://governance.openstack.org/badges/tosca-parser.svg + :target: http://governance.openstack.org/reference/tags/index.html + +.. Change things from this point on + +=============== +TOSCA Parser +=============== + +Overview +-------- + +The TOSCA Parser is an OpenStack project and licensed under Apache 2. It is +developed to parse TOSCA Simple Profile in YAML. It reads the TOSCA templates +and creates an in-memory graph of TOSCA nodes and their relationship. + +Architecture +------------ + +The TOSCA Parser takes TOSCA YAML template or TOSCA Cloud Service Archive (CSAR) +file as an input, with optional input of dictionary of needed parameters with their +values, and produces in-memory objects of different TOSCA elements with their +relationship to each other. It also creates a graph of TOSCA node templates and their +relationship. + +The ToscaTemplate class located in the toscaparser/tosca_template.py is an entry +class of the parser and various functionality of parser can be used by initiating +this class. In order to see an example usage of TOSCA Parser from a separate tool, +refer to the OpenStack heat-translator class TranslateTemplate located in the +translator/osc/v1/translate.py module. The toscaparser/shell.py module of tosca-parser +also provides a good reference on how to invoke TOSCA Parser from Command Line Interface. + +The toscaparser/elements sub-directory contains various modules to handle +various TOSCA type elements like node type, relationship type etc. The +entity_type.py module is a parent of all type elements. The toscaparser +directory contains various python module to handle service template including +topology template, node templates, relationship templates etc. The +entity_template.py is a parent of all template elements. + + +How To Use +---------- +Please refer to `doc/source/usage.rst <https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst>`_ + +Project Info +------------ + +* License: Apache License, Version 2.0 +* Source: http://git.openstack.org/cgit/openstack/tosca-parser/ + diff --git a/tosca2heat/tosca-parser/setup.cfg b/tosca2heat/tosca-parser/setup.cfg index 77e1b2e..45a5ae7 100644 --- a/tosca2heat/tosca-parser/setup.cfg +++ b/tosca2heat/tosca-parser/setup.cfg @@ -3,7 +3,7 @@ name = tosca-parser url = https://launchpad.net/tosca-parser summary = Parser for TOSCA Simple Profile in YAML. description-file = - README.rst + README.md author = OpenStack author-email = openstack-dev@lists.openstack.org home-page = http://docs.openstack.org/developer/tosca-parser/ @@ -28,14 +28,6 @@ packages = console_scripts = tosca-parser = toscaparser.shell:main -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = toscaparser/locale domain = toscaparser |