sandloom-admin 0.7.0a6__tar.gz

sandloom_admin-0.7.0a6/.gitignore

@@ -0,0 +1,4 @@
+# Build artifacts from `uv build` — not committed.
+dist/
+build/
+*.egg-info/

sandloom_admin-0.7.0a6/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog — sandloom-admin
+
+All notable changes to the `sandloom-admin` distribution are documented here.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+Per-package entries are aggregated in the repository-level [docs/changelog.md](../../docs/changelog.md).
+
+## [Unreleased]
+
+## [0.7.0a6] — 2026-11-01
+
+### Added
+
+- The admin console as a package: a prebuilt web UI served by the application at
+  `/admin/`, off in production unless `ADMIN_CONSOLE_ENABLED=true`.

sandloom_admin-0.7.0a6/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sandloom_admin-0.7.0a6/NOTICE

@@ -0,0 +1,8 @@
+Sandloom
+Copyright 2026 Vasyl Cherniavskyi
+
+The original Sandloom framework code, documentation and examples are licensed
+under the Apache License, Version 2.0. See LICENSE for the full terms.
+
+Third-party components and assets retain their own copyright notices and
+licenses. This notice does not replace or modify those terms.

sandloom_admin-0.7.0a6/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.5
+Name: sandloom-admin
+Version: 0.7.0a6
+Summary: The admin console for Sandloom: a prebuilt web UI for the platform owner, with no Node or separate image.
+Project-URL: Homepage, https://sandloom.dev/
+Project-URL: Documentation, https://sandloom.dev/docs/
+Project-URL: Repository, https://github.com/Sandloom-dev/sandloom
+Project-URL: Issues, https://github.com/Sandloom-dev/sandloom/issues
+Project-URL: Changelog, https://github.com/Sandloom-dev/sandloom/blob/main/packages/sandloom-admin/CHANGELOG.md
+Author: Vasyl Cherniavskyi
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.11
+Requires-Dist: sandloom<0.8,>=0.7.0a6
+Description-Content-Type: text/markdown
+
+# sandloom-admin
+
+**The admin console for Sandloom.**
+
+A web console for the platform owner: users, organizations, billing, audit and
+service health. It ships ready to run inside this package, so you need neither Node
+nor a separate image.
+
+Part of [Sandloom](https://github.com/Sandloom-dev/sandloom), the Python backend
+framework for AI-driven development.
+
+## Included
+
+- The built console, served by your application at `/admin/`.
+- Screens from the `admin.py` declarations of your modules, with no frontend build.
+- Off in production unless you set `ADMIN_CONSOLE_ENABLED=true`.
+
+## Install
+
+```bash
+uvx --from "sandloom[standard]==0.7.0a6" sandloom new myapp --with admin
+```
+
+Or add it to an existing application:
+
+```bash
+uv add "sandloom[admin]"
+```
+
+Add `"admin"` to `BUNDLED` in your `asgi.py`, then run `uv run sandloom generate`.
+
+See the [Admin Console documentation](https://sandloom.dev/docs/admin-console/).

sandloom_admin-0.7.0a6/README.md

@@ -0,0 +1,32 @@
+# sandloom-admin
+
+**The admin console for Sandloom.**
+
+A web console for the platform owner: users, organizations, billing, audit and
+service health. It ships ready to run inside this package, so you need neither Node
+nor a separate image.
+
+Part of [Sandloom](https://github.com/Sandloom-dev/sandloom), the Python backend
+framework for AI-driven development.
+
+## Included
+
+- The built console, served by your application at `/admin/`.
+- Screens from the `admin.py` declarations of your modules, with no frontend build.
+- Off in production unless you set `ADMIN_CONSOLE_ENABLED=true`.
+
+## Install
+
+```bash
+uvx --from "sandloom[standard]==0.7.0a6" sandloom new myapp --with admin
+```
+
+Or add it to an existing application:
+
+```bash
+uv add "sandloom[admin]"
+```
+
+Add `"admin"` to `BUNDLED` in your `asgi.py`, then run `uv run sandloom generate`.
+
+See the [Admin Console documentation](https://sandloom.dev/docs/admin-console/).

sandloom_admin-0.7.0a6/pyproject.toml

@@ -0,0 +1,37 @@
+[project]
+name = "sandloom-admin"
+version = "0.7.0a6"
+classifiers = ["Development Status :: 3 - Alpha"]
+description = "The admin console for Sandloom: a prebuilt web UI for the platform owner, with no Node or separate image."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{ name = "Vasyl Cherniavskyi" }]
+requires-python = ">=3.11"
+# An ecosystem module like any third party's: a compatible framework range.
+# The console signs in through identity, a separate distribution, which the
+# `sandloom[admin]` extra and `sandloom new --with admin` add.
+dependencies = [
+    "sandloom>=0.7.0a6,<0.8",
+]
+
+[project.urls]
+Homepage = "https://sandloom.dev/"
+Documentation = "https://sandloom.dev/docs/"
+Repository = "https://github.com/Sandloom-dev/sandloom"
+Issues = "https://github.com/Sandloom-dev/sandloom/issues"
+Changelog = "https://github.com/Sandloom-dev/sandloom/blob/main/packages/sandloom-admin/CHANGELOG.md"
+
+# The module name and
+# its import path; SANDLOOM_MODULES may name it by either.
+[project.entry-points."sandloom.modules"]
+admin = "sandloom_admin"
+
+[build-system]
+requires = [
+    "hatchling>=1.27",
+]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["sandloom_admin"]

sandloom_admin-0.7.0a6/sandloom_admin/__init__.py

@@ -0,0 +1,13 @@
+"""The platform owner's console: a prebuilt web UI, served at ``/admin/``.
+
+The UI talks only to the modules' public APIs, so this module holds no tables,
+events or contracts, and every authorization decision stays with those APIs.
+The screens come from the ``admin.py`` declarations of the composed modules,
+which ``sandloom generate`` compiles to ``<app>/shared/admin-manifest.json``.
+"""
+
+from sandloom.sdk import define_module
+
+register = define_module(__name__, version="1.0.0")
+
+__all__ = ["register"]

sandloom_admin-0.7.0a6/sandloom_admin/api.py

@@ -0,0 +1,140 @@
+"""Serve the console's files, its configuration and the application's manifest."""
+
+import json
+from importlib import resources
+from pathlib import Path
+from typing import Any
+
+from fastapi import Depends, HTTPException
+from fastapi.responses import FileResponse, JSONResponse, RedirectResponse
+
+from sandloom.sdk import module_router, public
+from sandloom.sdk.infra import settings
+
+MANIFEST = "admin-manifest.json"
+PACKAGED = Path(__file__).parent / "console"
+#: The UI loads nothing from elsewhere and is framed by nothing.
+CSP = (
+    "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; "
+    "img-src 'self' data:; font-src 'self' data:; connect-src 'self'; "
+    "frame-ancestors 'none'; base-uri 'self'; form-action 'self'"
+)
+NOT_GENERATED = "The admin manifest is missing: run `sandloom generate` and restart."
+
+
+def _enabled() -> None:
+    enabled = settings.admin_console_enabled
+    if enabled is None:
+        enabled = settings.environment.value != "prod"
+    if not enabled:
+        raise HTTPException(404, "Not found")
+
+
+router = module_router(
+    prefix="/admin",
+    tags=["admin-console"],
+    dependencies=[
+        public(reason="the console's static files; every API it calls checks access"),
+        Depends(_enabled),
+    ],
+)
+
+
+def _console() -> Path:
+    custom = settings.admin_console_dist
+    return Path(custom) if custom else PACKAGED
+
+
+def _read_manifest() -> dict[str, Any] | None:
+    """The first manifest found in the application's generated packages."""
+    for package in (*settings.contract_dto_packages, "sandloom.shared"):
+        try:
+            file = resources.files(package) / MANIFEST
+            if file.is_file():
+                parsed: dict[str, Any] = json.loads(file.read_text(encoding="utf-8"))
+                return parsed
+        except ModuleNotFoundError:
+            continue
+    return None
+
+
+def _problem(manifest: dict[str, Any], console: dict[str, Any]) -> str | None:
+    """Why this console cannot show this manifest, in terms the operator can act on."""
+    if manifest.get("version") not in console["manifest_versions"]:
+        return (
+            f"This console does not support admin manifest version "
+            f"{manifest.get('version')!r}: align the sandloom and sandloom-admin "
+            "versions, then run `sandloom generate`."
+        )
+    named = {
+        widget
+        for resource in manifest.get("resources", [])
+        for field in ("show_widgets", "edit_widgets")
+        for widget in resource.get(field, [])
+    }
+    unknown = sorted(named - set(console["widgets"]))
+    if unknown:
+        return (
+            f"This console does not include {', '.join(unknown)}: upgrade "
+            "sandloom-admin to match the installed modules."
+        )
+    return None
+
+
+def _usable_manifest() -> dict[str, Any]:
+    manifest = _read_manifest()
+    if manifest is None:
+        raise HTTPException(503, NOT_GENERATED)
+    described = _console() / "console.json"
+    if described.is_file():
+        problem = _problem(manifest, json.loads(described.read_text(encoding="utf-8")))
+        if problem:
+            raise HTTPException(503, problem)
+    return manifest
+
+
+def _json(payload: dict[str, Any]) -> JSONResponse:
+    return JSONResponse(payload, headers={"Cache-Control": "no-store"})
+
+
+@router.get("", include_in_schema=False)
+async def console_root() -> RedirectResponse:
+    return RedirectResponse("/admin/", status_code=308)
+
+
+@router.get(f"/{MANIFEST}", include_in_schema=False)
+async def admin_manifest() -> JSONResponse:
+    return _json(_usable_manifest())
+
+
+@router.get("/config.json", include_in_schema=False)
+async def console_config() -> JSONResponse:
+    """Every section the manifest declares: composition already selected them."""
+    modules = [m for m in _usable_manifest()["modules"] if m != "core"]
+    if "identity" not in modules:
+        raise HTTPException(503, "The admin console needs the identity module.")
+    return _json({"modules": modules})
+
+
+@router.get("/{path:path}", include_in_schema=False)
+async def console_file(path: str) -> FileResponse:
+    root = _console().resolve()
+    file = (root / path).resolve()
+    if file != root and root in file.parents and file.is_file():
+        if "assets" in file.relative_to(root).parts:
+            # The file name carries its content hash.
+            cache = "public, max-age=31536000, immutable"
+        else:
+            cache = "no-store"
+        return FileResponse(file, headers={"Cache-Control": cache})
+    # A deep link is the browser's route. A missing file must stay a 404, or a
+    # stale script tag would receive HTML.
+    if "." in path.rsplit("/", 1)[-1]:
+        raise HTTPException(404, "Not found")
+    index = root / "index.html"
+    if not index.is_file():
+        raise HTTPException(503, "The admin console files are missing.")
+    return FileResponse(
+        index,
+        headers={"Cache-Control": "no-store", "Content-Security-Policy": CSP},
+    )