generated from coulomb/repo-seed
59 lines
2.6 KiB
Markdown
59 lines
2.6 KiB
Markdown
# guide-board
|
|
|
|
`guide-board` is a certification and compliance preparation framework. It turns
|
|
standards, conformance, regulatory, and repository-quality claims into structured
|
|
evidence that can be reviewed, repeated, compared, and used during assessments.
|
|
|
|
The root project owns the framework contracts. Domain-specific work lives in
|
|
extensions.
|
|
|
|
## Local Baseline
|
|
|
|
The first core is intentionally dependency-light. From a clean checkout:
|
|
|
|
```sh
|
|
PYTHONPATH=src python3 -m guide_board extensions list
|
|
PYTHONPATH=src python3 -m guide_board extensions validate
|
|
PYTHONPATH=src python3 -m guide_board profile validate-target profiles/targets/sample-repository.json
|
|
PYTHONPATH=src python3 -m guide_board profile validate-assessment profiles/assessments/sample-noop.json
|
|
PYTHONPATH=src python3 -m guide_board plan \
|
|
--target profiles/targets/sample-repository.json \
|
|
--assessment profiles/assessments/sample-noop.json
|
|
PYTHONPATH=src python3 -m guide_board run \
|
|
--target profiles/targets/sample-repository.json \
|
|
--assessment profiles/assessments/sample-noop.json
|
|
PYTHONPATH=src python3 -m guide_board runs list
|
|
PYTHONPATH=src python3 -m guide_board runs trend
|
|
PYTHONPATH=src python3 -m guide_board runs gate
|
|
PYTHONPATH=src python3 -m guide_board serve --host 127.0.0.1 --port 8080
|
|
PYTHONPATH=src python3 -m unittest discover -s tests
|
|
```
|
|
|
|
External extension repos plug in with `--extension-dir`:
|
|
|
|
```sh
|
|
PYTHONPATH=src python3 -m guide_board --extension-dir ../open-cmis-tck extensions list
|
|
PYTHONPATH=src python3 -m guide_board --extension-dir ../open-cmis-tck plan \
|
|
--target ../open-cmis-tck/profiles/targets/kontextual-cmis-compat.json \
|
|
--assessment ../open-cmis-tck/profiles/assessments/cmis-browser-baseline.json
|
|
```
|
|
|
|
The same CLI contracts are packaged by the container baseline. See
|
|
[docs/CONTAINER.md](docs/CONTAINER.md). The dependency-light local API wraps
|
|
those contracts for service and container operation; see
|
|
[docs/LOCAL-SERVICE-API.md](docs/LOCAL-SERVICE-API.md).
|
|
|
|
The `sample-noop` extension exercises the guide-board contracts without invoking
|
|
an external harness. `open-cmis-tck` is the first real seed extension.
|
|
|
|
See:
|
|
|
|
- [INTENT.md](INTENT.md)
|
|
- [docs/ARCHITECTURE-BLUEPRINT.md](docs/ARCHITECTURE-BLUEPRINT.md)
|
|
- [docs/COMPLIANCE-EVIDENCE-PACKS.md](docs/COMPLIANCE-EVIDENCE-PACKS.md)
|
|
- [docs/CONTAINER.md](docs/CONTAINER.md)
|
|
- [docs/EXTENSION-SDK.md](docs/EXTENSION-SDK.md)
|
|
- [docs/LOCAL-SERVICE-API.md](docs/LOCAL-SERVICE-API.md)
|
|
- [extensions/CANDIDATES.md](extensions/CANDIDATES.md)
|
|
- [workplans/GUIDE-BOARD-WP-0001-bootstrapping.md](workplans/GUIDE-BOARD-WP-0001-bootstrapping.md)
|