Initialize organizations module
This commit is contained in:
44
README.md
Normal file
44
README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# GovOPlaN Organizations
|
||||
|
||||
`govoplan-organizations` is the canonical organizational model module for
|
||||
GovOPlaN.
|
||||
|
||||
It owns organization units, organizational hierarchy, functions, and
|
||||
account-held function assignments. These facts exist independently of
|
||||
authentication and authorization. IDM can import them, Identity can link them
|
||||
to people/accounts, and Access can project them into roles and rights.
|
||||
|
||||
## Boundary
|
||||
|
||||
Organizations owns:
|
||||
|
||||
- tenant-local organization units
|
||||
- parent/child organizational hierarchy
|
||||
- functions in organization units
|
||||
- whether a function may be delegated or used for acting in place
|
||||
- account-held function assignments
|
||||
- whether an assignment applies only to one unit or also to subunits
|
||||
|
||||
Organizations does not own:
|
||||
|
||||
- login accounts or identity lifecycle
|
||||
- role and permission evaluation
|
||||
- postboxes, workflows, portals, files, or cases
|
||||
- external IDM connector internals
|
||||
|
||||
## Module Contract
|
||||
|
||||
The module registers the `organizations.directory` capability from
|
||||
`govoplan_core.core.organizations`.
|
||||
|
||||
Feature modules should consume the capability instead of importing
|
||||
organization ORM models.
|
||||
|
||||
## Development Install
|
||||
|
||||
From the core checkout:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./.venv/bin/python -m pip install -e ../govoplan-organizations
|
||||
```
|
||||
Reference in New Issue
Block a user