SAService Architect Back to designer
SAService ArchitectDocumentation
Python DSL reference pip install -e . | sa-dsl check | sa-dsl build | sa-dsl import

Installation and commands

Install the package and use its CLI for validation, YAML output, and reverse generation.

When to use

Use these commands in local development and CI before requesting target-language code.

Behavior

  • check loads the Python entry point and prints validation diagnostics without writing YAML.
  • build validates and emits YAML to stdout or a selected file.
  • import converts existing Service Architect YAML into a modular typed Python package.

CLI commands properties

Commands installed by the sa-python-dsl package.

PropertyTypeDescription
sa-dsl check <source>validation

Validate a Python graph without writing YAML.

sa-dsl build <source>serialization

Write YAML to stdout.

sa-dsl build <source> -o <file>serialization

Write YAML to a file.

sa-dsl import <yaml> -o <package>reverse generation

Create an importable Python project from YAML.

Shell

python -m venv .venv
. .venv/bin/activate
pip install -e .

sa-dsl check examples/processorder/main.py
sa-dsl build examples/processorder/main.py -o architecture.yaml