openstack/tosca-parser
Code Issues Proposed changes
Parser for TOSCA Simple Profile in YAML.
757 Commits 10 Branches 59 Tags 4.7 MiB
Python 100%
0501264fa0
Go to file
Ghanshyam Mann 0501264fa0 [ussuri][goal] Update contributor documentation 
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38524
Change-Id: I2a91b3917a3d119aec2f53cc3e65fa6cc73381c0
2021-06-01 13:48:43 +00:00
doc [ussuri][goal] Update contributor documentation 2021-06-01 13:48:43 +00:00
toscaparser Merge "Simplify log translations" 2021-03-24 09:22:29 +00:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:56:14 +00:00
.gitignore Use stestr instead of testr 2018-06-19 13:32:34 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:33:52 +00:00
.mailmap Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
.stestr.conf Use stestr instead of testr 2018-06-19 13:32:34 -05:00
.zuul.yaml Add Python3 wallaby unit tests 2020-11-27 03:58:12 +00:00
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2021-06-01 13:48:43 +00:00
HACKING.rst Replace git.openstack.org URLs with opendev.org URLs 2019-06-20 14:31:56 +08:00
LICENSE Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
lower-constraints.txt Remove depreciated file babel.cfg 2021-02-12 06:53:08 +05:30
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-06-20 14:31:56 +08:00
requirements.txt Remove depreciated file babel.cfg 2021-02-12 06:53:08 +05:30
setup.cfg Remove depreciated file babel.cfg 2021-02-12 06:53:08 +05:30
setup.py [ussuri][goal] Drop python 2.7 support and testing 2020-02-04 18:49:57 +01:00
test-requirements.txt Move tosca-parser to new hacking 4.0.0 2021-01-26 16:30:49 +05:30
tosca_parser.py Create shell entry point 2015-11-11 12:09:31 -08:00
tox.ini Update TOX_CONSTRAINTS_FILE 2021-01-29 00:15:57 +05:30

README.rst

Team and repository tags

image

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

Project Info