Skip to content

README.md

Latest commit

 

History

History
31 lines (24 loc) · 1.41 KB

README.md

File metadata and controls

31 lines (24 loc) · 1.41 KB
Raw

boundver examples

These small repositories-in-a-repository demonstrate each built-in boundary style. Run every command from the boundver repository root so component paths resolve consistently.

Install the CLI first:

python -m pip install boundver
Example What it demonstrates
Behavior tier Separate runtime-behavior and API-boundary fingerprints
OpenAPI A raw OpenAPI artifact as a service boundary
JSON file A generic JSON contract
Python package Public Python exports
TypeScript package A TypeScript export barrel
Implicit and leaf Gradual adoption and components with no consumers

Each example contains a config, sample component files, and expected.boundary.lock.json. Its README uses the same source mode for generation and verification:

boundver generate --config examples/EXAMPLE/boundary.config.json \
  --out examples/EXAMPLE/expected.boundary.lock.json \
  --source working-tree
boundver verify --config examples/EXAMPLE/boundary.config.json \
  --lock examples/EXAMPLE/expected.boundary.lock.json \
  --source working-tree

The examples show declared-artifact drift, not proof of semantic compatibility. Edit a tracked example file, rerun verify, and inspect which facet changes; regenerate afterward to restore the expected lockfile.