Create access module package
This commit is contained in:
56
README.md
Normal file
56
README.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# GovOPlaN Access
|
||||
|
||||
`govoplan-access` is the platform module for GovOPlaN identity,
|
||||
authentication, sessions, API keys, RBAC, groups, users, and access
|
||||
administration.
|
||||
|
||||
The repository contains the extracted access seed implementation under
|
||||
`src/govoplan_access/backend`. Some live product routes and legacy ORM models
|
||||
still reside in `govoplan-core` as compatibility code while the staged
|
||||
extraction continues. The staged extraction path is documented in:
|
||||
|
||||
- `/mnt/DATA/git/govoplan-core/docs/ACCESS_EXTRACTION_PLAN.md`
|
||||
- `/mnt/DATA/git/govoplan-core/docs/MODULE_ARCHITECTURE.md`
|
||||
|
||||
## Initial Ownership
|
||||
|
||||
This module will own:
|
||||
|
||||
- accounts and login identity
|
||||
- authentication routes and session lifecycle
|
||||
- API keys
|
||||
- tenant-local users
|
||||
- groups and memberships
|
||||
- roles and role assignments
|
||||
- principal resolution
|
||||
- permission evaluation
|
||||
- access administration backend routes
|
||||
- access administration WebUI route contributions
|
||||
- access-owned migrations
|
||||
|
||||
The kernel remains responsible for module discovery, route aggregation,
|
||||
database/session lifecycle, migration orchestration, capability registry, and
|
||||
stable contracts.
|
||||
|
||||
## Gitea Workflow
|
||||
|
||||
This repository uses the shared GovOPlaN Gitea issue workflow. Issue templates
|
||||
are installed under `.gitea/`, and the shared label taxonomy is copied to
|
||||
`docs/gitea-labels.json`.
|
||||
|
||||
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-access --apply
|
||||
```
|
||||
|
||||
## Development Install
|
||||
|
||||
From the core checkout:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./.venv/bin/python -m pip install -e ../govoplan-access
|
||||
```
|
||||
Reference in New Issue
Block a user