https://github.com/structural-explainability/se-constitution

Canonical specification and validation system for Structural Explainability repository classes, dependencies, and constraints.
https://github.com/structural-explainability/se-constitution

dependency-rules formal-specification governance naming-conventions python repository-architecture schema-validation specification structural-explainability typed-dict

Last synced: about 1 month ago
JSON representation

Canonical specification and validation system for Structural Explainability repository classes, dependencies, and constraints.

• Host: GitHub
• URL: https://github.com/structural-explainability/se-constitution
• Owner: structural-explainability
• License: mit
• Created: 2026-04-22T14:06:04.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2026-04-28T00:11:24.000Z (about 1 month ago)
• Last Synced: 2026-04-28T02:22:30.510Z (about 1 month ago)
• Topics: dependency-rules, formal-specification, governance, naming-conventions, python, repository-architecture, schema-validation, specification, structural-explainability, typed-dict
• Language: Python
• Homepage: https://structural-explainability.github.io/se-constitution/
• Size: 93.8 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Citation: CITATION.cff
  • Agents: AGENTS.md

Awesome Lists containing this project

README

          
# se-constitution

[![Docs Site](https://img.shields.io/badge/docs-site-blue?logo=github)](https://structural-explainability.github.io/se-constitution/)

[![Repo](https://img.shields.io/badge/repo-GitHub-black?logo=github)](https://github.com/structural-explainability/se-constitution)

[![Python 3.15+](https://img.shields.io/badge/python-3.15%2B-blue?logo=python)](./pyproject.toml)

[![License](https://img.shields.io/badge/license-MIT-yellow.svg)](./LICENSE)

[![CI](https://github.com/structural-explainability/se-constitution/actions/workflows/ci-python-zensical.yml/badge.svg?branch=main)](https://github.com/structural-explainability/se-constitution/actions/workflows/ci-python-zensical.yml)

[![Docs](https://github.com/structural-explainability/se-constitution/actions/workflows/deploy-zensical.yml/badge.svg?branch=main)](https://github.com/structural-explainability/se-constitution/actions/workflows/deploy-zensical.yml)

[![Links](https://github.com/structural-explainability/se-constitution/actions/workflows/links.yml/badge.svg?branch=main)](https://github.com/structural-explainability/se-constitution/actions/workflows/links.yml)

> Structural Explainability Constitution:

> rules, schemas, and validation for the SE ecosystem.

## Context

se-constitution

- defines rules

se-kernel

- defines primitives those rules depend on

se-admin

- enforces rules across repositories

## Command Reference

Show command reference

### In a machine terminal

Open a machine terminal where you want the project:

```shell

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

cd se-constitution

code .

```

### In a VS Code terminal

```shell

uv self update

uv python pin 3.15

uv sync --extra dev --extra docs --upgrade

git submodule update --init --recursive

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

# run the module

uv run python -m se_constitution validate

# do chores

npx markdownlint-cli "**/*.md" --fix

uv run python -m ruff format .

uv run python -m ruff check . --fix

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](./CITATION.cff)

## License

[LICENSE](./LICENSE)

## Manifest

[SE_MANIFEST.toml](./SE_MANIFEST.toml)