Initialize GovOPlaN module seed

This commit is contained in:
2026-07-10 18:39:11 +02:00
commit 173426f0a4
20 changed files with 1114 additions and 0 deletions
+1
View File
@@ -0,0 +1 @@
"""GovOPlaN Permits module."""
+1
View File
@@ -0,0 +1 @@
"""Backend integration for the GovOPlaN Permits module."""
+102
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 = "permits"
MODULE_NAME = "Permits"
MODULE_VERSION = "0.1.6"
READ_SCOPE = "permits:workspace:read"
WRITE_SCOPE = "permits:workspace:write"
ADMIN_SCOPE = "permits:workspace:admin"
OPTIONAL_DEPENDENCIES = (
"cases",
"inspections",
"forms-runtime",
"files",
"portal",
"certificates",
"records",
)
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="Permits",
level="tenant",
module_id=module_id,
resource=resource,
action=action,
)
PERMISSIONS = (
_permission(READ_SCOPE, "View permits workspace", "Read permits records, configuration, and workflow context."),
_permission(WRITE_SCOPE, "Manage permits workspace", "Create and update permits records and workflow state."),
_permission(ADMIN_SCOPE, "Administer permits workspace", "Configure permits policies, templates, and tenant-level administration."),
)
ROLE_TEMPLATES = (
RoleTemplate(
slug="permits_manager",
name="Permits manager",
description="Manage permits records and workflow state.",
permissions=(READ_SCOPE, WRITE_SCOPE),
),
RoleTemplate(
slug="permits_viewer",
name="Permits viewer",
description="Read permits records and workflow context.",
permissions=(READ_SCOPE,),
),
)
DOCUMENTATION = (
DocumentationTopic(
id=f"{MODULE_ID}.module-boundary",
title=f"{MODULE_NAME} module boundary",
summary="Permit and license workflows for applications, renewals, conditions, inspections, objections, revocations, and compliance evidence.",
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-permits/docs/PERMITS_DOMAIN_BOUNDARY.md",
kind="repository",
),
),
metadata={
"seed": True,
"domain_objects": ['permit application lifecycle', 'license and permit records', 'conditions', 'renewals', 'objections', 'revocation state', 'inspection handoffs'],
"first_slice": "Define permit type, application, decision, condition, renewal, objection, revocation, and inspection link 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