Skip to main content

No project description provided

Project description

SE Theory: Reference Kit

PyPI Docs Site Repo Python 3.15 License

CI-Lean CI Docs-Deploy Pre-Release Release Links Dependabot

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.

Overview

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.

Package Interface

  • 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.

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-theory-reference-kit

cd se-theory-reference-kit
code .

In a VS Code terminal

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

Authority Manifest

.accountability/surfaces.toml

Citation

CITATION.cff

License

MIT

Repository Manifest

SE_MANIFEST.toml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

se_theory_reference_kit-0.2.0.tar.gz (77.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

se_theory_reference_kit-0.2.0-py3-none-any.whl (44.4 kB view details)

Uploaded Python 3

File details

Details for the file se_theory_reference_kit-0.2.0.tar.gz.

File metadata

  • Download URL: se_theory_reference_kit-0.2.0.tar.gz
  • Upload date:
  • Size: 77.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for se_theory_reference_kit-0.2.0.tar.gz
Algorithm Hash digest
SHA256 eac69c6343dd57c2612415c8965d9dab93d8ee319674519ae3491bf2d29001e5
MD5 1addbac04502ab2f3cfa43c904e90ec9
BLAKE2b-256 79ec8d66fb1a8e32995ef8ca4963f76bccdd3cabdf7d819b8554e447a8298489

See more details on using hashes here.

Provenance

The following attestation bundles were made for se_theory_reference_kit-0.2.0.tar.gz:

Publisher: release-pypi.yml on structural-explainability/se-theory-reference-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file se_theory_reference_kit-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for se_theory_reference_kit-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58561636c823aea0856a6d53742b1288012639693c42ae4e7dec4bd21f98c768
MD5 9e3d76796548cd9e57ed8253546f1406
BLAKE2b-256 1de44bf2758d0cd781adf54441e69fd62971b320114c0f7c44ee8cf9798f5a42

See more details on using hashes here.

Provenance

The following attestation bundles were made for se_theory_reference_kit-0.2.0-py3-none-any.whl:

Publisher: release-pypi.yml on structural-explainability/se-theory-reference-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page