keepup-modules 0.5.0__tar.gz

keepup_modules-0.5.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: keepup-modules
+Version: 0.5.0
+Summary: The catalogue of panel sections, and the decision about backend plugins.
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: keepup-admin>=0.4.0
+Requires-Dist: keepup-db>=0.4.0
+Requires-Dist: keepup-users>=0.4.0
+Requires-Dist: keepup-auth>=0.4.0
+Requires-Dist: fastapi<1,>=0.128
+Requires-Dist: pydantic<3,>=2.11
+
+# keepup-modules
+
+The catalogue of panel sections, and the decision about backend plugins.
+
+One capability of [keepup](https://github.com/FedorSergeev/keepup-admin), the framework over FastAPI for admin
+panels: the base is installed as `keepup-admin` and imported as `keepup`, and
+this distribution carries one part of it. It is installed on its own
+(`pip install keepup-modules`) or together with the base (`pip install "keepup-admin[panel]"`),
+and it declares itself to the kernel through its
+`[project.entry-points."keepup.plugins"]` entry point.

keepup_modules-0.5.0/README.md

@@ -0,0 +1,10 @@
+# keepup-modules
+
+The catalogue of panel sections, and the decision about backend plugins.
+
+One capability of [keepup](https://github.com/FedorSergeev/keepup-admin), the framework over FastAPI for admin
+panels: the base is installed as `keepup-admin` and imported as `keepup`, and
+this distribution carries one part of it. It is installed on its own
+(`pip install keepup-modules`) or together with the base (`pip install "keepup-admin[panel]"`),
+and it declares itself to the kernel through its
+`[project.entry-points."keepup.plugins"]` entry point.

keepup_modules-0.5.0/keepup_modules/__init__.py

@@ -0,0 +1,42 @@
+"""The catalogue of panel sections, and the decision about backend plugins.
+
+This distribution provides `catalogue` and `plugin_decisions` and declares one
+plugin, `modules`, in the `keepup.plugins` group. It depends on `keepup-admin`
+for the constructor, on `keepup-db` for the two tables the catalogue keeps, on
+`keepup-users` for the roles a section is granted to, on `keepup-auth` for the
+panel guard of its routes -- the temporary edge the route bridge carries until
+`keepup-http` mounts what a plugin declares (keepup-121) -- and on `keepup-audit`
+for the trail an administrator's change is written to.
+"""
+
+from keepup_modules.catalogue import (
+    get_all_modules_from_db,
+    get_module_by_id,
+    get_modules_for_role,
+    get_modules_for_roles,
+    sync_framework_sections,
+    sync_new_modules_from_json,
+)
+
+__version__ = "0.5.0"
+
+__all__ = [
+    "get_all_modules_from_db",
+    "get_module_by_id",
+    "get_modules_for_role",
+    "get_modules_for_roles",
+    "sync_framework_sections",
+    "sync_new_modules_from_json",
+]
+
+#: What the entry point asks for, looked up on access: importing the catalogue
+#: model must not import the plugin's panel wiring.
+_PLUGIN_NAMES = {"ModulesPlugin", "SERVICE_CATALOGUE", "SERVICE_PLUGIN_DECISIONS"}
+
+
+def __getattr__(name):
+    if name in _PLUGIN_NAMES:
+        from keepup_modules import plugin
+
+        return getattr(plugin, name)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")