Initialize GovOPlaN module seed
This commit is contained in:
61
README.md
Normal file
61
README.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# GovOPlaN Certificates
|
||||
|
||||
`govoplan-certificates` is the GovOPlaN platform module seed for issuing, revoking, verifying, and archiving certificates, attestations, participation confirmations, permits, and eligibility statements.
|
||||
|
||||
This repository is initialized as a discoverable module seed. It exposes a module manifest, initial permissions, role templates, documentation metadata, Gitea workflow templates, and a focused manifest test. It intentionally does not yet add HTTP routes, database models, migrations, or WebUI navigation.
|
||||
|
||||
## Initial Ownership
|
||||
|
||||
- certificate issuance records
|
||||
- revocation and verification state
|
||||
- attestation metadata
|
||||
- archive references
|
||||
- eligibility statements
|
||||
|
||||
## Boundaries
|
||||
|
||||
This module does not own:
|
||||
|
||||
- learning course execution
|
||||
- permit adjudication workflows
|
||||
- document binary storage
|
||||
|
||||
Detailed boundary notes are in [docs/CERTIFICATES_DOMAIN_BOUNDARY.md](docs/CERTIFICATES_DOMAIN_BOUNDARY.md).
|
||||
|
||||
## Integrations
|
||||
|
||||
Expected optional integrations:
|
||||
|
||||
- learning
|
||||
- cases
|
||||
- forms-runtime
|
||||
- files
|
||||
- portal
|
||||
- records
|
||||
|
||||
## Development Install
|
||||
|
||||
From the core checkout:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./.venv/bin/python -m pip install -e ../govoplan-certificates
|
||||
```
|
||||
|
||||
Focused manifest verification:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-certificates
|
||||
PYTHONPATH=src:/mnt/DATA/git/govoplan-core/src /mnt/DATA/git/govoplan-core/.venv/bin/python -m unittest discover -s tests
|
||||
```
|
||||
|
||||
## Gitea Workflow
|
||||
|
||||
Issue templates are installed under `.gitea/`, and the shared label taxonomy is copied to `docs/gitea-labels.json` with the module label `module/certificates`.
|
||||
|
||||
From the core checkout, labels can be synced once a local `GITEA_TOKEN` is available:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./scripts/gitea-sync-labels.py --root /mnt/DATA/git/govoplan-certificates --apply
|
||||
```
|
||||
Reference in New Issue
Block a user