openstack/tosca-parser
Code Issues Proposed changes
Parser for TOSCA Simple Profile in YAML.
460 Commits 10 Branches 56 Tags 4.7 MiB
Python 100%
02e49a8609
Go to file
Matt Rutkowski 02e49a8609 Add OSX specific file extensions to gitignore 
Added a section to the proejct .gitignore file to add
OSX specific file extensions to. Added the primary
extension that causes issues i.e., .DS_Store which
gets added by the OSX Finder utility.

Change-Id: Ic78f8e367e2401868c7df1b49ef72f57f5cc3011
2016-02-11 17:46:13 -06:00
doc/source Update documentation for NFV profile support 2016-02-03 10:36:45 -06:00
toscaparser Merge "Changed datatype_definitions tag to data_types to match spec" 2016-02-03 22:14:52 +00:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:56:14 +00:00
.gitignore Add OSX specific file extensions to gitignore 2016-02-11 17:46:13 -06:00
.gitreview Update gitreview file 2015-08-24 19:30:47 -07:00
.mailmap Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
.testr.conf Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
babel.cfg Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
CONTRIBUTING.rst Create README 2015-08-25 16:20:42 -07:00
HACKING.rst Create README 2015-08-25 16:20:42 -07:00
LICENSE Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
MANIFEST.in Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
openstack-common.conf Update setup config file 2015-08-26 05:36:23 -07:00
README.rst Fix CSAR usage in README 2016-02-03 09:32:03 -08:00
requirements.txt Updated from global requirements 2016-01-16 03:33:55 +00:00
setup.cfg Create shell entry point 2015-11-11 12:09:31 -08:00
setup.py Updated from global requirements 2015-12-02 21:25:51 +00:00
test-requirements.txt Updated from global requirements 2016-01-16 03:33:55 +00:00
tosca_parser.py Create shell entry point 2015-11-11 12:09:31 -08:00
tox.ini Put py34 first in the env order of tox 2015-12-22 18:36:50 +05:30

README.rst

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