Files
govoplan-contracts/README.md

63 lines
1.7 KiB
Markdown

# GovOPlaN Contracts
`govoplan-contracts` is the GovOPlaN platform module seed for contract register for renewals, obligations, responsible units, documents, sign-off chains, and vendor or partner references.
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
- contract register
- renewal reminders
- obligation tracking
- responsible-unit assignment
- sign-off chain references
- vendor and partner links
## Boundaries
This module does not own:
- procurement request execution
- document storage
- payment scheduling
Detailed boundary notes are in [docs/CONTRACTS_DOMAIN_BOUNDARY.md](docs/CONTRACTS_DOMAIN_BOUNDARY.md).
## Integrations
Expected optional integrations:
- procurement
- approvals
- files
- records
- notifications
- ledger
## Development Install
From the core checkout:
```bash
cd /mnt/DATA/git/govoplan-core
./.venv/bin/python -m pip install -e ../govoplan-contracts
```
Focused manifest verification:
```bash
cd /mnt/DATA/git/govoplan-contracts
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/contracts`.
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-contracts --apply
```