Initialize GovOPlaN module seed

This commit is contained in:
2026-07-10 18:39:11 +02:00
commit 8470df60d7
20 changed files with 1114 additions and 0 deletions

View File

@@ -0,0 +1 @@
"""GovOPlaN Grants module."""

View File

@@ -0,0 +1 @@
"""Backend integration for the GovOPlaN Grants module."""

View File

@@ -0,0 +1,102 @@
from __future__ import annotations
from govoplan_core.core.access import CAPABILITY_AUTH_PERMISSION_EVALUATOR, CAPABILITY_AUTH_PRINCIPAL_RESOLVER
from govoplan_core.core.modules import DocumentationLink, DocumentationTopic, ModuleManifest, PermissionDefinition, RoleTemplate
MODULE_ID = "grants"
MODULE_NAME = "Grants"
MODULE_VERSION = "0.1.6"
READ_SCOPE = "grants:workspace:read"
WRITE_SCOPE = "grants:workspace:write"
ADMIN_SCOPE = "grants:workspace:admin"
OPTIONAL_DEPENDENCIES = (
"approvals",
"cases",
"files",
"payments",
"ledger",
"reporting",
"audit",
)
def _permission(scope: str, label: str, description: str) -> PermissionDefinition:
module_id, resource, action = scope.split(":", 2)
return PermissionDefinition(
scope=scope,
label=label,
description=description,
category="Grants",
level="tenant",
module_id=module_id,
resource=resource,
action=action,
)
PERMISSIONS = (
_permission(READ_SCOPE, "View grants workspace", "Read grants records, configuration, and workflow context."),
_permission(WRITE_SCOPE, "Manage grants workspace", "Create and update grants records and workflow state."),
_permission(ADMIN_SCOPE, "Administer grants workspace", "Configure grants policies, templates, and tenant-level administration."),
)
ROLE_TEMPLATES = (
RoleTemplate(
slug="grants_manager",
name="Grants manager",
description="Manage grants records and workflow state.",
permissions=(READ_SCOPE, WRITE_SCOPE),
),
RoleTemplate(
slug="grants_viewer",
name="Grants viewer",
description="Read grants records and workflow context.",
permissions=(READ_SCOPE,),
),
)
DOCUMENTATION = (
DocumentationTopic(
id=f"{MODULE_ID}.module-boundary",
title=f"{MODULE_NAME} module boundary",
summary="Grant and funding program workflows for applications, eligibility, awards, milestones, payout claims, reporting duties, and audits.",
body=(
"This repository is currently a platform module seed. It registers the domain boundary, "
"permission surface, role templates, and documentation metadata before runtime APIs, "
"database models, migrations, and WebUI routes are introduced."
),
layer="available",
documentation_types=("admin",),
audience=("operator", "module_admin", "product_owner"),
order=100,
related_modules=OPTIONAL_DEPENDENCIES,
links=(
DocumentationLink(
label="Repository domain boundary",
href="govoplan-grants/docs/GRANTS_DOMAIN_BOUNDARY.md",
kind="repository",
),
),
metadata={
"seed": True,
"domain_objects": ['funding programs', 'grant applications', 'eligibility checks', 'award records', 'milestones', 'payout claims', 'reporting duties'],
"first_slice": "Define funding program, application, eligibility, award, milestone, payout claim, and reporting-duty records.",
},
),
)
manifest = ModuleManifest(
id=MODULE_ID,
name=MODULE_NAME,
version=MODULE_VERSION,
dependencies=("access",),
optional_dependencies=OPTIONAL_DEPENDENCIES,
required_capabilities=(CAPABILITY_AUTH_PRINCIPAL_RESOLVER, CAPABILITY_AUTH_PERMISSION_EVALUATOR),
permissions=PERMISSIONS,
role_templates=ROLE_TEMPLATES,
documentation=DOCUMENTATION,
)
def get_manifest() -> ModuleManifest:
return manifest

View File