tosca2heat/tosca-parser-0.3.0/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 as an input, with optional input of
  16 dictionary of needed parameters with their values, and produces in-memory
  17 objects of different TOSCA elements with their relationship to each other. It
  18 also creates a graph of TOSCA node templates and their relationship. The support
  19 for parsing template within TOSCA CSAR is under development.
  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, refer to the heat-translator
  24 class TranslateTemplate located in the translator/osc/v1/translate.py module.
  25
  26 The toscaparser/elements sub-directory contains various modules to handle
  27 various TOSCA type elements like node type, relationship type etc. The
  28 entity_type.py module is a parent of all type elements. The toscaparser
  29 directory contains various python module to handle service template including
  30 topology template, node templates, relationship templates etc. The
  31 entity_template.py is a parent of all template elements.
  32
  33
  34 How To Use
  35 ----------
  36 Please refer to `doc/source/usage.rst <https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst>`_
  37
  38 Project Info
  39 ------------
  40
  41 * License: Apache License, Version 2.0
  42 * Source: http://git.openstack.org/cgit/openstack/tosca-parser/
  43