simple-module-settings 0.0.1__py3-none-any.whl

settings/services.py

@@ -0,0 +1,36 @@
+"""Module-scoped state container.
+
+Stored as ``app.state.settings`` by
+:meth:`SettingsModule.register_settings`.
+
+Not frozen — ``on_startup`` may set fields that depend on the DB or
+other framework services. Convention: set once during boot, treat as
+read-only after.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from settings.contracts.registry import SettingsRegistry
+from settings.module_registry import ModuleSettingsRegistry
+from settings.settings import SettingsSettings
+
+
+@dataclass
+class SettingsServices:
+    """Settings module singletons.
+
+    ``registry`` is shared across the whole app — consumer modules register
+    their setting keys here (typically from their own ``on_startup`` hook)
+    so admins can discover every knob and the accessor can fall back to
+    declared defaults.
+
+    ``module_registry`` tracks per-module ``BaseSettings`` classes registered
+    via ``register_module_settings``; the hosting lifespan uses it to hydrate
+    each module's effective settings from the DB before ``on_startup`` runs.
+    """
+
+    settings: SettingsSettings
+    registry: SettingsRegistry = field(default_factory=SettingsRegistry)
+    module_registry: ModuleSettingsRegistry = field(default_factory=ModuleSettingsRegistry)

settings/settings.py

@@ -0,0 +1,11 @@
+"""Settings module's own configuration (DB-backed)."""
+
+from __future__ import annotations
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class SettingsSettings(BaseSettings):
+    """Configuration for the Settings module."""
+
+    model_config = SettingsConfigDict(extra="ignore")

settings/store.py

@@ -0,0 +1,61 @@
+"""DB-backed key/value store for module settings (SYSTEM scope).
+
+Wraps the existing SettingService. Keys are namespaced ``<package>.<field>``
+to avoid collision with free-form user-defined setting keys.
+"""
+
+from __future__ import annotations
+
+from settings.constants import SYSTEM_SCOPE_ID
+from settings.contracts.schemas import SettingScope, SettingUpsert, SettingValueType
+from settings.service import SettingService
+
+
+def _key(package: str, field: str) -> str:
+    return f"{package}.{field}"
+
+
+class SettingsStore:
+    """SYSTEM-scoped key/value store keyed by ``(package, field)``."""
+
+    def __init__(self, service: SettingService) -> None:
+        self._service = service
+
+    async def get_overrides(self, package: str) -> dict[str, tuple[str, str]]:
+        """Return ``{field_name: (raw_value, value_type)}`` for a package."""
+        prefix = f"{package}."
+        items = await self._service.list_by_scope(SettingScope.SYSTEM, SYSTEM_SCOPE_ID)
+        out: dict[str, tuple[str, str]] = {}
+        for item in items:
+            if not item.key.startswith(prefix):
+                continue
+            field_name = item.key[len(prefix) :]
+            if "." in field_name:
+                continue
+            out[field_name] = (item.value, item.value_type)
+        return out
+
+    async def set_override(self, package: str, field: str, value: str, value_type: str) -> None:
+        await self._service.upsert_scoped(
+            SettingScope.SYSTEM,
+            SYSTEM_SCOPE_ID,
+            _key(package, field),
+            SettingUpsert(value=value, value_type=SettingValueType(value_type)),
+        )
+
+    async def clear_override(self, package: str, field: str) -> None:
+        await self._service.delete_scoped(
+            SettingScope.SYSTEM, SYSTEM_SCOPE_ID, _key(package, field)
+        )
+
+    async def list_packages_with_overrides(self) -> list[str]:
+        items = await self._service.list_by_scope(SettingScope.SYSTEM, SYSTEM_SCOPE_ID)
+        pkgs: set[str] = set()
+        for item in items:
+            if "." not in item.key:
+                continue
+            pkg, rest = item.key.split(".", 1)
+            if "." in rest:
+                continue
+            pkgs.add(pkg)
+        return sorted(pkgs)

simple_module_settings-0.0.1.dist-info/METADATA

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: simple_module_settings
+Version: 0.0.1
+Summary: Runtime settings UI — modules plug their own settings panels into a shared admin view
+Project-URL: Homepage, https://github.com/antosubash/simple_module_python
+Project-URL: Repository, https://github.com/antosubash/simple_module_python
+Project-URL: Issues, https://github.com/antosubash/simple_module_python/issues
+Project-URL: Changelog, https://github.com/antosubash/simple_module_python/blob/main/CHANGELOG.md
+Author-email: Anto Subash <antosubash@live.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: admin,configuration,settings,simple-module
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: simple-module-core==0.0.1
+Requires-Dist: simple-module-db==0.0.1
+Requires-Dist: simple-module-hosting==0.0.1
+Description-Content-Type: text/markdown
+
+# simple_module_settings
+
+Runtime settings UI for [simple_module](https://github.com/antosubash/simple_module_python) apps. Other modules plug their own settings panels into a shared admin view — one page per module tab — without the host having to know about them.
+
+## Install
+
+```bash
+pip install simple_module_settings
+```
+
+## What it provides
+
+- `/settings` admin page aggregating every installed module's settings panel.
+- `register_settings_panel()` hook — a module declares `{title, inertia_page, requires_permission}`; `simple_module_settings` renders the tab.
+- DB-backed runtime settings table (separate from env-var-driven `SM_*` settings) for values admins change at runtime.
+
+## Usage
+
+Register a panel:
+
+```python
+class OrdersModule(ModuleBase):
+    meta = ModuleMeta(name="orders")
+
+    def register_settings_panel(self):
+        return {
+            "title": "Orders",
+            "inertia_page": "Orders/SettingsPanel",
+            "requires_permission": "orders.manage",
+        }
+```
+
+That adds an **Orders** tab at `/settings`. The rendered page is a regular Inertia page authored inside the `orders` module.
+
+## Depends on
+
+- `simple_module_core`, `simple_module_db`, `simple_module_hosting`
+
+## License
+
+MIT — see [LICENSE](https://github.com/antosubash/simple_module_python/blob/main/LICENSE).

simple_module_settings-0.0.1.dist-info/RECORD

@@ -0,0 +1,41 @@
+settings/__init__.py,sha256=QvBSBkRsWCrl_h6TbbceY8wsG3VHa-rZyHkBJAK3DBk,23
+settings/_module_settings.py,sha256=feKyRbLDHipLQtqnI11JYwWygNFrGG4ArBjh06JpyL4,5501
+settings/cli.py,sha256=KWKYoDzrv8tLuxs-cx0hnD8HEnfRN4pKVTIVOfZQdZo,2475
+settings/constants.py,sha256=OjaY4YjQPn_ukPMpUR9szwmfQNGcxfNYoUtbU2Ij_uk,5784
+settings/deps.py,sha256=b-VNFTIa_6wC8SOXnGyRy9MmrRVdAgRPFz1sYtNqzvY,2134
+settings/env_vars.py,sha256=_AP8Sxd_5Zg_zCip4h6ATaHIY-87Fu3mv1jMk0yKKXo,578
+settings/hydrate.py,sha256=z1TVrohDIkmz5deUsYOqDwaJqNu01MPCAIA9reRjm2M,2009
+settings/models.py,sha256=6agZmTGZB8wa40xzqYUX075W1V8Kh2VN5u-iG_z13U4,1875
+settings/module.py,sha256=U3eM0laD_zaye1rcQMBPXLpfxGm7U5qo8rsScEmWv8I,2448
+settings/module_registry.py,sha256=fKkn0s1Qfwb5oC5hoZtY6JnSuFcidhgdGOlMD9La3rk,1073
+settings/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+settings/registration.py,sha256=qgclQBC3U4oBUqASW8rypNB5BwzVBUBZh5rewcCwSnk,1127
+settings/reload.py,sha256=XqS8ejXvtJguk17sOVXxUiFVbnqZfMZnHiJ3aUNcAO8,1786
+settings/service.py,sha256=euw39CKZyHFszkrddYauQrlLiml9T4K75NLtiBScoG0,6289
+settings/services.py,sha256=x0GcwYVqGFonRc0O4lQL8maocJdWXFZp4NO2BokJgYw,1277
+settings/settings.py,sha256=0fauk-Jjt3EuPWTMeoNJSlCBmukw__1mu0y4GQ5UeVg,299
+settings/store.py,sha256=MlLd7V3gWHgrTOKirEQXZbr9qngQ3q67UqA77fmyqm4,2239
+settings/contracts/__init__.py,sha256=YcvVFbGmMiG3rNZ7ucXrr2m1YNDiNmBSUzPRHOfAVhs,568
+settings/contracts/accessor.py,sha256=1GdPkY0nWSdSARRfkwVvKtKHbnGdDgP-IjtgWeB2gTI,7664
+settings/contracts/events.py,sha256=Ii7TPTeX-l3Wlxhl8BasW1sdMNZA_7t3H_oXD2ilb4o,510
+settings/contracts/registry.py,sha256=IRGZs33FMn63DbQ7A2Ryih5eVeG4YjIMewiMb2Zkhcw,2350
+settings/contracts/schemas.py,sha256=182JfnRWmmIPrHreQU2cR0x4CvxuvIWFI5FDYGQB_tU,4834
+settings/endpoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+settings/endpoints/api.py,sha256=f_5mnMrH5fxGnYz_YK0KcQaFxHawQr3vNq01GuGTmBA,6211
+settings/endpoints/module_api.py,sha256=bRehranGhNy35ETKt8EaJomqU-sJYHdE1v2GodandvE,3634
+settings/endpoints/views.py,sha256=ESoU9BRbiPu7Ugty7TvC_o-u1jzejV7Zkeue7S6AJ9Q,4143
+settings/locales/en.json,sha256=2lUi1IOpMerqjCqfagABj7RktCdMgYfoKzf-ac75erQ,1981
+settings/pages/Browse.tsx,sha256=TrUkjfSrpmsSRHDl3E863ULEeFhw-w5GuStB5KgoDLg,4054
+settings/pages/Create.tsx,sha256=3agamQsnTZSqzShKWdrhh3zKJ_viaKTurcMDCiw1hqE,4262
+settings/pages/Edit.tsx,sha256=dMxsWkyIYs3FRi0FG0KBEfAZJ6EUvVBQoVPYJZPMcNY,3433
+settings/pages/ModulesEdit.tsx,sha256=j2gW6mcAyypplMhdlrg-dthFujZ3PF-KSAxxYSh84Dc,2619
+settings/pages/routes.ts,sha256=Az-ZyapYL0ERhMIJ691TCFF9UspYPJfDKvpyzEawpaE,212
+settings/pages/components/FieldInput.tsx,sha256=dYKY2kIIHLprjmPCSGngKUa_vRuihZlTHftEJAW6HRg,2431
+settings/pages/components/ModuleForm.tsx,sha256=V9tr1NKhMUGbP9qYaYMKj5z6xx4fiPQo_qzOQkSVroA,5247
+settings/pages/components/ValueInput.tsx,sha256=DVA53bcwiBPssORlJLx5y--NYdlvXK3-92403UQtqAM,2207
+settings/package.json,sha256=sRi7iWCtnjrg6W8jzGobPwq-2gduRSbq--RiKw6JQ9g,379
+simple_module_settings-0.0.1.dist-info/METADATA,sha256=emXVxIpniaCN0AVn5SYGK1-nPkplCTzsDMz1UUNKKKk,2620
+simple_module_settings-0.0.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+simple_module_settings-0.0.1.dist-info/entry_points.txt,sha256=WNiRkLdOVTEDrNfawkYO8q2m2wb52W6LJNp0nfn9vI4,109
+simple_module_settings-0.0.1.dist-info/licenses/LICENSE,sha256=Yn66lhLklsF5p7pa85_ksQrJ79Q-FgOaUAHevLBjer4,1068
+simple_module_settings-0.0.1.dist-info/RECORD,,

simple_module_settings-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

simple_module_settings-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+sm-settings = settings.cli:main
+
+[simple_module]
+settings = settings.module:SettingsModule

simple_module_settings-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anto Subash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.