gerrit.onap Code Review - sdc/sdc-distribution-client.git/blob

   1 Metadata-Version: 1.1
   2 Name: tosca-parser
   3 Version: 0.7.0
   4 Summary: Parser for TOSCA Simple Profile in YAML.
   5 Home-page: http://docs.openstack.org/developer/tosca-parser/
   6 Author: OpenStack
   7 Author-email: openstack-dev@lists.openstack.org
   8 License: UNKNOWN
   9 Description: ========================
  10         Team and repository tags
  11         ========================
  12
  13         .. image:: http://governance.openstack.org/badges/tosca-parser.svg
  14             :target: http://governance.openstack.org/reference/tags/index.html
  15
  16         .. Change things from this point on
  17
  18         ===============
  19         TOSCA Parser
  20         ===============
  21
  22         Overview
  23         --------
  24
  25         The TOSCA Parser is an OpenStack project and licensed under Apache 2. It is
  26         developed to parse TOSCA Simple Profile in YAML. It reads the TOSCA templates
  27         and creates an in-memory graph of TOSCA nodes and their relationship.
  28
  29         Architecture
  30         ------------
  31
  32         The TOSCA Parser takes TOSCA YAML template or TOSCA Cloud Service Archive (CSAR)
  33         file as an input, with optional input of dictionary of needed parameters with their
  34         values, and produces in-memory objects of different TOSCA elements with their
  35         relationship to each other. It also creates a graph of TOSCA node templates and their
  36         relationship.
  37
  38         The ToscaTemplate class located in the toscaparser/tosca_template.py is an entry
  39         class of the parser and various functionality of parser can be used by initiating
  40         this class. In order to see an example usage of TOSCA Parser from a separate tool,
  41         refer to the OpenStack heat-translator class TranslateTemplate located in the
  42         translator/osc/v1/translate.py module. The toscaparser/shell.py module of tosca-parser
  43         also provides a good reference on how to invoke TOSCA Parser from Command Line Interface.
  44
  45         The toscaparser/elements sub-directory contains various modules to handle
  46         various TOSCA type elements like node type, relationship type etc. The
  47         entity_type.py module is a parent of all type elements. The toscaparser
  48         directory contains various python module to handle service template including
  49         topology template, node templates, relationship templates etc. The
  50         entity_template.py is a parent of all template elements.
  51
  52
  53         How To Use
  54         ----------
  55         Please refer to `doc/source/usage.rst <https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst>`_
  56
  57         Project Info
  58         ------------
  59
  60         * License: Apache License, Version 2.0
  61         * Source: http://git.openstack.org/cgit/openstack/tosca-parser/
  62
  63
  64 Platform: UNKNOWN
  65 Classifier: Environment :: OpenStack
  66 Classifier: Intended Audience :: Information Technology
  67 Classifier: Intended Audience :: System Administrators
  68 Classifier: License :: OSI Approved :: Apache Software License
  69 Classifier: Operating System :: POSIX :: Linux
  70 Classifier: Programming Language :: Python
  71 Classifier: Programming Language :: Python :: 2
  72 Classifier: Programming Language :: Python :: 2.7
  73 Classifier: Programming Language :: Python :: 3
  74 Classifier: Programming Language :: Python :: 3.4
  75 Classifier: Programming Language :: Python :: 3.5