tosca2heat/tosca-parser/README.rst

   1 ===============
   2 TOSCA Parser
   3 ===============
   4
   5 Overview
   6 --------
   7
   8 The TOSCA Parser is an OpenStack project and licensed under Apache 2. It is
   9 developed to parse TOSCA Simple Profile in YAML. It reads the TOSCA templates
  10 and creates an in-memory graph of TOSCA nodes and their relationship.
  11
  12 Architecture
  13 ------------
  14
  15 The TOSCA Parser takes TOSCA YAML template or TOSCA Cloud Service Archive (CSAR)
  16 file as an input, with optional input of dictionary of needed parameters with their
  17 values, and produces in-memory objects of different TOSCA elements with their
  18 relationship to each other. It also creates a graph of TOSCA node templates and their
  19 relationship.
  20
  21 The ToscaTemplate class located in the toscaparser/tosca_template.py is an entry
  22 class of the parser and various functionality of parser can be used by initiating
  23 this class. In order to see an example usage of TOSCA Parser from a separate tool,
  24 refer to the OpenStack heat-translator class TranslateTemplate located in the
  25 translator/osc/v1/translate.py module. The toscaparser/shell.py module of tosca-parser
  26 also provides a good reference on how to invoke TOSCA Parser from Command Line Interface.
  27
  28 The toscaparser/elements sub-directory contains various modules to handle
  29 various TOSCA type elements like node type, relationship type etc. The
  30 entity_type.py module is a parent of all type elements. The toscaparser
  31 directory contains various python module to handle service template including
  32 topology template, node templates, relationship templates etc. The
  33 entity_template.py is a parent of all template elements.
  34
  35
  36 How To Use
  37 ----------
  38 Please refer to `doc/source/usage.rst <https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst>`_
  39
  40 Project Info
  41 ------------
  42
  43 * License: Apache License, Version 2.0
  44 * Source: http://git.openstack.org/cgit/openstack/tosca-parser/
  45