simple-module-settings 0.0.1__tar.gz → 0.0.3__tar.gz

{simple_module_settings-0.0.1 → simple_module_settings-0.0.3}/.gitignore

@@ -36,6 +36,10 @@ uploads/
 # Vite
 host/static/dist/
 
+# VitePress (docs)
+docs/.vitepress/cache/
+docs/.vitepress/dist/
+
 # Auto-generated frontend module manifest (regenerated by the host at boot
 # or via `make gen-pages`).
 host/client_app/modules.manifest.json

{simple_module_settings-0.0.1 → simple_module_settings-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simple_module_settings
-Version: 0.0.1
+Version: 0.0.3
 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
@@ -21,9 +21,10 @@ 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
+Requires-Dist: simple-module-core==0.0.3
+Requires-Dist: simple-module-db==0.0.3
+Requires-Dist: simple-module-hosting==0.0.3
+Requires-Dist: typer>=0.12
 Description-Content-Type: text/markdown
 
 # simple_module_settings

{simple_module_settings-0.0.1 → simple_module_settings-0.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simple_module_settings"
-version = "0.0.1"
+version = "0.0.3"
 description = "Runtime settings UI — modules plug their own settings panels into a shared admin view"
 readme = "README.md"
 license = "MIT"
@@ -21,16 +21,17 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "simple_module_core==0.0.1",
-    "simple_module_db==0.0.1",
-    "simple_module_hosting==0.0.1",
+    "simple_module_core==0.0.3",
+    "simple_module_db==0.0.3",
+    "simple_module_hosting==0.0.3",
+    "typer>=0.12",
 ]
 
 [project.entry-points.simple_module]
 settings = "settings.module:SettingsModule"
 
-[project.scripts]
-sm-settings = "settings.cli:main"
+[project.entry-points."simple_module_cli.cli_plugins"]
+settings = "settings.cli:app"
 
 [project.urls]
 Homepage = "https://github.com/antosubash/simple_module_python"

simple_module_settings-0.0.3/settings/cli.py

@@ -0,0 +1,61 @@
+"""``sm settings`` plugin — currently only ``import-from-env``.
+
+One-shot migration: walks every registered module's BaseSettings and
+writes a SYSTEM-scoped override for each ``SM_<PREFIX>_<FIELD>`` env
+var that is set.
+"""
+
+from __future__ import annotations
+
+import asyncio
+import os
+
+import typer
+from fastapi import FastAPI
+
+from settings.constants import MODULE_PACKAGE
+from settings.env_vars import env_prefix_for
+from settings.hydrate import value_type_for_field
+from settings.store import SettingsStore
+
+app = typer.Typer(help="Settings module administration.", no_args_is_help=True)
+
+
+async def import_from_env_impl(app_inst: FastAPI, store: SettingsStore) -> int:
+    """Write a SYSTEM override for every ``SM_<PREFIX>_<FIELD>`` env var set."""
+    registry = getattr(app_inst.state, MODULE_PACKAGE).module_registry
+    count = 0
+    for package, cls in registry.items():
+        prefix = env_prefix_for(package)
+        for field_name in cls.model_fields:
+            raw = os.environ.get(f"{prefix}{field_name.upper()}")
+            if raw is None:
+                continue
+            vtype = value_type_for_field(cls, field_name)
+            await store.set_override(package, field_name, raw, vtype)
+            count += 1
+    return count
+
+
+@app.command("import-from-env")
+def import_from_env() -> None:
+    """Write SYSTEM overrides for every SM_<PREFIX>_<FIELD> env var set."""
+    from simple_module_hosting.app_builder import create_app
+    from simple_module_hosting.settings import Settings
+
+    from settings.service import SettingService
+
+    fastapi_app = create_app(Settings())
+
+    async def run() -> int:
+        async with (
+            fastapi_app.router.lifespan_context(fastapi_app),
+            fastapi_app.state.sm.db.session_factory() as session,
+        ):
+            store = SettingsStore(SettingService(session))
+            n = await import_from_env_impl(fastapi_app, store)
+            await session.commit()
+            typer.echo(f"Imported {n} override(s) from environment.")
+        return 0
+
+    raise typer.Exit(code=asyncio.run(run()))

simple_module_settings-0.0.1/settings/cli.py

@@ -1,78 +0,0 @@
-"""``sm-settings`` CLI — currently only ``import-from-env``.
-
-One-shot migration: walks every registered module's ``BaseSettings`` and,
-for each field whose legacy ``SM_<PREFIX>_<FIELD>`` env var is set, writes
-a SYSTEM-scoped override into the Settings store.
-"""
-
-from __future__ import annotations
-
-import asyncio
-import os
-import sys
-
-from fastapi import FastAPI
-
-from settings.constants import MODULE_PACKAGE
-from settings.env_vars import env_prefix_for
-from settings.hydrate import value_type_for_field
-from settings.store import SettingsStore
-
-
-async def import_from_env_impl(app: FastAPI, store: SettingsStore) -> int:
-    """Write a SYSTEM override for every ``SM_<PREFIX>_<FIELD>`` env var set.
-
-    Returns the count of overrides written. Env vars that don't match a
-    registered field are ignored.
-    """
-    registry = getattr(app.state, MODULE_PACKAGE).module_registry
-    count = 0
-    for package, cls in registry.items():
-        prefix = env_prefix_for(package)
-        for field_name in cls.model_fields:
-            raw = os.environ.get(f"{prefix}{field_name.upper()}")
-            if raw is None:
-                continue
-            vtype = value_type_for_field(cls, field_name)
-            await store.set_override(package, field_name, raw, vtype)
-            count += 1
-    return count
-
-
-def main() -> int:
-    """Console-script entry point for ``sm-settings``.
-
-    Supports a single subcommand: ``import-from-env``.
-    """
-    argv = sys.argv[1:]
-    if not argv or argv[0] in ("-h", "--help"):
-        print("Usage: sm-settings import-from-env")
-        return 0 if argv else 1
-    if argv[0] != "import-from-env":
-        print(f"Unknown command: {argv[0]}", file=sys.stderr)
-        print("Usage: sm-settings import-from-env", file=sys.stderr)
-        return 2
-
-    from simple_module_hosting.app_builder import create_app
-    from simple_module_hosting.settings import Settings
-
-    from settings.service import SettingService
-
-    app = create_app(Settings())
-
-    async def run() -> int:
-        async with (
-            app.router.lifespan_context(app),
-            app.state.sm.db.session_factory() as session,
-        ):
-            store = SettingsStore(SettingService(session))
-            n = await import_from_env_impl(app, store)
-            await session.commit()
-            print(f"Imported {n} override(s) from environment.")
-        return 0
-
-    return asyncio.run(run())
-
-
-if __name__ == "__main__":
-    sys.exit(main())