Semantics as Code

Tutorial

Getting started

Clone the repository, install the Python reference CLI, validate the examples, and generate documentation and platform artifacts.

Prerequisites

  • Python 3.10 or newer
  • Git
  • Node.js only if you are working on this website

Clone and install

git clone https://github.com/vkondepati/semantics-as-code.git
cd semantics-as-code
pip install -e ".[dev]"

Validate and lint

semantics validate examples/supply-chain
semantics lint examples/supply-chain
semantics validate examples/retail
semantics lint examples/retail

Generate documentation and diagrams

semantics generate examples/supply-chain --target markdown --output dist/docs
semantics generate examples/supply-chain --target html --output dist/html
semantics generate examples/supply-chain --target mermaid --output dist/diagrams

Generate vendor and AI outputs

semantics generate examples/supply-chain --target dbt --output dist/dbt
semantics generate examples/supply-chain --target openmetadata --output dist/openmetadata
semantics generate examples/supply-chain --target ai-context --output dist/ai
semantics generate examples/supply-chain --target knowledge-graph --output dist/kg
semantics generate examples/supply-chain --target databricks --output dist/databricks
semantics generate examples/supply-chain --target snowflake --output dist/snowflake
semantics generate examples/supply-chain --target fabric --output dist/fabric
semantics generate examples/supply-chain --target bigquery --output dist/bigquery
semantics generate examples/supply-chain --target apache-metadata --output dist/apache

Inspect semantic differences

semantics diff --base examples/supply-chain --head examples/retail

Run tests

python -m pytest

Expected structure

examples/supply-chain/
  semantics.yaml
  domains/
  entities/
  metrics/
  glossary/
  relationships/
  quality/
Top