Shared Python engine for validating, scaffolding, and exporting Structural Explainability theory-reference artifacts that mirror Lean public surfaces.
For the full documentation, see docs/en/index.md.
This project provides the shared Python infrastructure used by Structural Explainability theory repositories to maintain reference artifacts aligned with their Lean public surfaces.
The kit owns generic loading, validation, scaffolding, and export machinery. Each theory repository owns its own public Lean surface declarations and export specifications.
- The Python import package is
se_theory_reference_kit. - The Python distribution package is
se-theory-reference-kit. - The public command is
se-theory-reference.
Show command reference
Open a machine terminal where you want the project:
git clone https://github.com/structural-explainability/se-theory-reference-kit
cd se-theory-reference-kit
code .Use VS Code Menu:
View / Command Palette / Developer: Reload Window to refresh.
uv self update
uv python pin 3.15
uv sync --extra dev --extra docs --upgrade
uvx pre-commit install
uv run se-theory-reference --help
uv run se-theory-reference validate --help
uv run se-theory-reference scaffold --help
uv run se-theory-reference export --help
uv run se-theory-reference catalog --help
uv run se-theory-reference inspect --help
# validate manifest file
uvx se-manifest-schema validate-manifest --path SE_MANIFEST.toml --strict
git add -A
uvx pre-commit run --all-files
# repeat if changes were made
uvx pre-commit run --all-files
uv run python -m pyright
uv run python -m pytest
uv run python -m zensical build
# check import layers
uvx --python 3.13 --from import-linter lint-imports --config .github/.importlinter
# check complexity; no output is good (all A or B)
uvx radon cc src/se_theory_reference_kit -s -a -n C
uv build
uvx twine check dist/*
# save progress
git add -A
git commit -m "update"
git push -u origin main