se-contract-kit 0.1.0

Generic contract loading, resolution, and validation machinery for Structural Explainability contract repositories.

SE Contract Kit

Provides generic contract loading, resolution, and validation machinery for Structural Explainability contract repositories.

It is a Python package and command-line tool.

Role

Owns reusable machinery for contract repositories. It does not own Accountable Record, Judicial Record, Civic Record, or any domain-specific contract content.

Package

uv add se-contract-kit

Command

uv run se-contract-kit check --strict

Source layout

base/          Dependency-free utilities for errors, file IO, JSON, and paths.
declarations/  Load repository manifest and contract declarations.
resolution/    Resolve dependencies, artifacts, authorities, lockfiles, and run context.
validation/    Run generic contract checks and produce validation results.
cli.py         Command-line entry point.

Command Reference

Show command reference

In a machine terminal

Open a machine terminal where you want the project:

git clone https://github.com/structural-explainability/se-contract-kit

cd se-contract-kit
code .

In a VS Code terminal

uv self update
uv python pin 3.14
uv sync --extra dev --extra docs --upgrade

uvx pre-commit install

git add -A
uvx pre-commit run --all-files
# repeat if changes were made
git add -A
uvx pre-commit run --all-files

# validate manifest
uv run se-manifest validate-manifest --path MANIFEST.toml --strict

# run contract-kit checks
uv run se-contract-kit check --strict

# types, tests, docs
uv run python -m pyright
uv run python -m pytest
uv run python -m zensical build

# save progress
git add -A
git commit -m "update"
git push -u origin main

Citation

CITATION.cff

License

MIT

Manifest

MANIFEST.toml