63 lines
2.9 KiB
Markdown
63 lines
2.9 KiB
Markdown
# govoplan-connectors
|
|
|
|
<!-- govoplan-repository-type:start -->
|
|
**Repository type:** connector (connector-hub).
|
|
<!-- govoplan-repository-type:end -->
|
|
|
|
`govoplan-connectors` owns integration catalogues and generic external system
|
|
connection patterns for GovOPlaN.
|
|
|
|
The module should make external systems discoverable, testable, and usable
|
|
without taking ownership of their business semantics. Domain-specific modules
|
|
remain responsible for case, file, workflow, payment, mail, identity, document,
|
|
or reporting behavior.
|
|
|
|
## Executable First Slice
|
|
|
|
The first executable connector capability provides tenant-isolated tabular
|
|
origins. Operators can import bounded JSON or CSV snapshots, inspect inferred
|
|
schemas, and expose immutable source references and content fingerprints
|
|
through `connectors.datasource_origins@0.1.0`. Preview reads enforce provider
|
|
ceilings for rows, serialized bytes, and elapsed time and report the effective
|
|
limits and any truncation as structured diagnostics.
|
|
|
|
Connectors owns acquisition, connection profiles, credentials, discovery, and
|
|
provider health. `govoplan-datasources` registers an origin as a governed live
|
|
or cached datasource and owns staging, materializations, frozen states, and
|
|
consumer access. Dataflow consumes that Datasources contract and never imports
|
|
connector implementations or stores connector credentials.
|
|
|
|
Each origin declares whether it is live, cached, file-backed, or static, its
|
|
structured health state, and which projection, filter, aggregation, sorting,
|
|
and pagination operations it can push down. The immutable snapshot provider
|
|
currently supports projection and pagination only; consumers must keep other
|
|
operations in Dataflow rather than assuming transport-side execution.
|
|
|
|
Database, REST/HTTP, directory, managed-file, and warehouse providers can
|
|
implement the same origin contract without changing Datasources or Dataflow.
|
|
|
|
Governed sanctions and feed snapshot acquisitions use Core recovery operations.
|
|
The source revision/cursor, redacted dry-run decision, canonical request digest,
|
|
and distributed lease are durable before network I/O. Immutable snapshot rows
|
|
and the terminal recovery checkpoint commit atomically, and an
|
|
`Idempotency-Key` replays the committed result without contacting the provider.
|
|
Current acquisition transports are read-only. The exported external-mutation
|
|
recovery contract requires stable idempotency, provider verification, and
|
|
operator reconciliation, but no connector currently claims a production write
|
|
or delete path.
|
|
|
|
Development:
|
|
|
|
```bash
|
|
/mnt/DATA/git/govoplan/.venv/bin/python -m pip install -e .
|
|
/mnt/DATA/git/govoplan/.venv/bin/python -m unittest discover -s tests
|
|
```
|
|
|
|
See:
|
|
|
|
- [Connector concept](docs/CONCEPT.md)
|
|
- [Public-sector integration catalogue](docs/PUBLIC_SECTOR_INTEGRATION_CATALOGUE.md)
|
|
- [Connector source lifecycle](docs/CONNECTOR_SOURCE_LIFECYCLE.md)
|
|
- [OpenProject connector concept](docs/OPENPROJECT_CONNECTOR.md)
|
|
- [OpenDesk integration map](docs/OPENDESK_INTEGRATION_MAP.md)
|