3 Commits
Author SHA1 Message Date
zemion 04d743896d docs: complete German structured documentation
Module Package Release / publish-packages (push) Successful in 10s
2026-08-24 01:15:34 +02:00
zemion 4ca65351ca docs: complete public documentation baseline
Module Package Release / publish-packages (push) Successful in 10s
2026-08-22 07:55:19 +02:00
zemion c1da5d23b7 Release v0.1.18
Module Package Release / publish-packages (push) Successful in 11s
2026-08-05 21:07:45 +02:00
5 changed files with 44 additions and 5 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@govoplan/grants", "name": "@govoplan/grants",
"version": "0.1.17", "version": "0.1.20",
"private": true, "private": true,
"description": "GovOPlaN Grants platform module seed.", "description": "GovOPlaN Grants platform module seed.",
"type": "module", "type": "module",
+3 -3
View File
@@ -4,15 +4,15 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "govoplan-grants" name = "govoplan-grants"
version = "0.1.17" version = "0.1.20"
description = "GovOPlaN Grants platform module seed." description = "GovOPlaN Grants platform module seed."
readme = "README.md" readme = "README.md"
requires-python = ">=3.12" requires-python = ">=3.12"
license = { file = "LICENSE" } license = { file = "LICENSE" }
authors = [{ name = "GovOPlaN" }] authors = [{ name = "GovOPlaN" }]
dependencies = [ dependencies = [
"govoplan-core>=0.1.17", "govoplan-core>=0.1.18",
"govoplan-access>=0.1.17", "govoplan-access>=0.1.18",
] ]
[tool.setuptools.packages.find] [tool.setuptools.packages.find]
@@ -0,0 +1,11 @@
"""German translations for public structured documentation metadata."""
from __future__ import annotations
from typing import Any
GERMAN_STRUCTURED_TRANSLATIONS: dict[str, dict[str, Any]] = {'grants.module-boundary': {'consequence_classes': {'seed_boundary': 'Erklärt nur Besitz und '
'Berechtigungen an; es ist '
'noch kein Laufzeit-Workflow '
'verfügbar.'}}}
+20 -1
View File
@@ -1,12 +1,15 @@
from __future__ import annotations from __future__ import annotations
from govoplan_core.core.modules import with_documentation_structured_translations
from govoplan_grants.backend.german_structured_documentation import GERMAN_STRUCTURED_TRANSLATIONS
from govoplan_core.core.access import CAPABILITY_AUTH_PERMISSION_EVALUATOR, CAPABILITY_AUTH_PRINCIPAL_RESOLVER 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 from govoplan_core.core.modules import DocumentationLink, DocumentationTopic, ModuleManifest, PermissionDefinition, RoleTemplate
from govoplan_core.core.provider_governance import declared_module_architecture from govoplan_core.core.provider_governance import declared_module_architecture
MODULE_ID = "grants" MODULE_ID = "grants"
MODULE_NAME = "Grants" MODULE_NAME = "Grants"
MODULE_VERSION = "0.1.17" MODULE_VERSION = "0.1.20"
READ_SCOPE = "grants:workspace:read" READ_SCOPE = "grants:workspace:read"
WRITE_SCOPE = "grants:workspace:write" WRITE_SCOPE = "grants:workspace:write"
ADMIN_SCOPE = "grants:workspace:admin" ADMIN_SCOPE = "grants:workspace:admin"
@@ -69,6 +72,13 @@ DOCUMENTATION = (
layer="available", layer="available",
documentation_types=("admin", "user"), documentation_types=("admin", "user"),
audience=("user", "operator", "module_admin", "product_owner"), audience=("user", "operator", "module_admin", "product_owner"),
translations={
"de": {
"title": "Modulgrenze von Grants",
"summary": "Förderprogrammabläufe für Anträge, Förderfähigkeit, Bewilligungen, Meilensteine, Auszahlungsanforderungen, Berichtspflichten und Prüfungen.",
"body": "Dieses Repository ist derzeit ein Grundgerüst für ein Plattformmodul. Es registriert die Fachgrenze, Berechtigungsoberfläche, Rollenvorlagen und Dokumentationsmetadaten, bevor Laufzeit-APIs, Datenbankmodelle, Migrationen und WebUI-Routen eingeführt werden.",
}
},
order=100, order=100,
related_modules=OPTIONAL_DEPENDENCIES, related_modules=OPTIONAL_DEPENDENCIES,
links=( links=(
@@ -79,7 +89,11 @@ DOCUMENTATION = (
), ),
), ),
metadata={ metadata={
"kind": "reference",
"seed": True, "seed": True,
"consequence_classes": {
"seed_boundary": "Declares ownership and permissions only; no runtime workflow is available yet.",
},
"domain_objects": ['funding programs', 'grant applications', 'eligibility checks', 'award records', 'milestones', 'payout claims', 'reporting duties'], "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.", "first_slice": "Define funding program, application, eligibility, award, milestone, payout claim, and reporting-duty records.",
}, },
@@ -108,5 +122,10 @@ manifest = ModuleManifest(
) )
manifest = with_documentation_structured_translations(
manifest, locale="de", translations=GERMAN_STRUCTURED_TRANSLATIONS
)
def get_manifest() -> ModuleManifest: def get_manifest() -> ModuleManifest:
return manifest return manifest
+9
View File
@@ -15,6 +15,15 @@ class ManifestSeedTests(unittest.TestCase):
self.assertEqual({permission.scope for permission in manifest.permissions}, {READ_SCOPE, WRITE_SCOPE, ADMIN_SCOPE}) self.assertEqual({permission.scope for permission in manifest.permissions}, {READ_SCOPE, WRITE_SCOPE, ADMIN_SCOPE})
self.assertEqual({role.slug for role in manifest.role_templates}, {"grants_manager", "grants_viewer"}) self.assertEqual({role.slug for role in manifest.role_templates}, {"grants_manager", "grants_viewer"})
self.assertTrue(manifest.documentation) self.assertTrue(manifest.documentation)
topic = manifest.documentation[0]
self.assertEqual("reference", topic.metadata["kind"])
self.assertIn("seed_boundary", topic.metadata["consequence_classes"])
self.assertTrue(
all(
topic.translations.get("de", {}).get(field)
for field in ("title", "summary", "body")
)
)
self.assertIsNone(manifest.route_factory) self.assertIsNone(manifest.route_factory)
self.assertIsNone(manifest.migration_spec) self.assertIsNone(manifest.migration_spec)
self.assertIsNone(manifest.frontend) self.assertIsNone(manifest.frontend)