63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
# GovOPlaN Records
|
|
|
|
`govoplan-records` is the GovOPlaN platform module seed for records management for file plans, records classification, retention schedules, disposal holds, and archive handoff.
|
|
|
|
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
|
|
|
|
- file plans
|
|
- records classification
|
|
- retention schedule application
|
|
- disposal holds
|
|
- archive handoff state
|
|
- legal record identity
|
|
|
|
## Boundaries
|
|
|
|
This module does not own:
|
|
|
|
- document binary storage
|
|
- DMS editing workflows
|
|
- generic privacy policy engine
|
|
|
|
Detailed boundary notes are in [docs/RECORDS_DOMAIN_BOUNDARY.md](docs/RECORDS_DOMAIN_BOUNDARY.md).
|
|
|
|
## Integrations
|
|
|
|
Expected optional integrations:
|
|
|
|
- files
|
|
- dms
|
|
- docs
|
|
- policy
|
|
- audit
|
|
- transparency
|
|
|
|
## Development Install
|
|
|
|
From the core checkout:
|
|
|
|
```bash
|
|
cd /mnt/DATA/git/govoplan-core
|
|
./.venv/bin/python -m pip install -e ../govoplan-records
|
|
```
|
|
|
|
Focused manifest verification:
|
|
|
|
```bash
|
|
cd /mnt/DATA/git/govoplan-records
|
|
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/records`.
|
|
|
|
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-records --apply
|
|
```
|