Parse MiCADO ADTs for the MiCADO Submitter
Project description
MiCADO Parser
The MiCADO component responsible for parsing and validating ADTs
Historically part of the MiCADO TOSCASubmitter, now a standalone library and command-line tool used inside MiCADO and on its own for validating single-file (YAML) and multi-file (CSAR) ADTs.
Dependencies
The MiCADO Parser uses the following packages:
Installation
Install the latest version of the MiCADO Parser from PyPI.
pip install micado-parser
or from GitHub.
git clone https://github.com/micado-scale/micado-parser
pip install micado-parser/.
Usage
Command-line
For some helpful tips, use the --help
option
micadoparser --help
To validate an ADT, simply point at an ADT.
micadoparser /home/ubuntu/adts/nginx.yaml
Multi-file ADTs in .csar format are also supported
micadoparser /home/ubuntu/adts/wordpress.csar
The tool can handle multiple files.
micadoparser ~/adts/nginx.yaml ~/adts/wordpress.csar
Or an entire directory.
micadoparser ~/adts/*
For verbose output use the -v
option (for even more verbosity use -vv
or -vvv
).
micadoparser -v ~/adts/nginx.yaml
Library
The primary function of the MiCADO Parser is to return a validated ToscaTemplate object.
To use it in your own project, simply import the set_template
function and pass it the path to your ADT. You can optionally pass a dictionary of TOSCA inputs, if inputs are defined in your ADT.
from micadoparser import set_template
tpl = set_template("/home/ubuntu/adts/nginx.yaml")
tpl_with_params = set_template(
"home/ubuntu/adts/wordpress.csar",
{"username": "jay", "token": "ABD992LOKAL"}
)
To use the package for validation only, use the set_template
function and catch the MultiError
exception.
from micadoparser import set_template, MultiError
try:
set_template("/home/ubuntu/adts/nginx.yaml")
except MultiError as e:
print(e)
Comparison with the OpenStack TOSCA Parser
The MiCADO Parser adds a few features compared to the upstream TOSCA Parser.
- MiCADO-specific validations
- MiCADO-specific CSAR handling
- Input resolution
- Support for some TOSCA v1.3 features
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file micado-parser-0.12.3.tar.gz
.
File metadata
- Download URL: micado-parser-0.12.3.tar.gz
- Upload date:
- Size: 16.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | da6a5d5e1147c6204e1d37ad3a587a675289dfa147ae6c642572022aeef420f6 |
|
MD5 | 111176723f1b425d87ef57a94cb4165a |
|
BLAKE2b-256 | 1347cc98fbac0ef0ce8b46448b8c7137162a6f722dcb7c425d95646064cc6dae |
File details
Details for the file micado_parser-0.12.3-py3-none-any.whl
.
File metadata
- Download URL: micado_parser-0.12.3-py3-none-any.whl
- Upload date:
- Size: 18.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e9f888dcbeaa3acea7d6deb7abde003956b7ab36f5dd1395a3698883ff26aaa |
|
MD5 | ad997c1d27e3d060106adadcec38066d |
|
BLAKE2b-256 | fa6452d2d042fa745c610d1dfd16eb98b078744518268e3002bf4ef60bb94c3f |