frontedge 0.1.0__tar.gz

frontedge-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+node_modules/
+dist/
+.venv/
+__pycache__/
+*.log
+
+# The built interface is copied into the Python package at build time
+python/frontedge/src/frontedge/static/index.html
+python/frontedge/src/frontedge/static/assets/
+
+# Local reference material stays out of the repository
+design-prompts-local/
+mockups-local/

frontedge-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 socrabs151
+
+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.

frontedge-0.1.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.5
+Name: frontedge
+Version: 0.1.0
+Summary: Frontend layer for ML engineering: mount ready-made screens into any FastAPI app
+Project-URL: Homepage, https://github.com/socrabs151/frontedge-ml
+Project-URL: Repository, https://github.com/socrabs151/frontedge-ml
+Project-URL: Issues, https://github.com/socrabs151/frontedge-ml/issues
+Project-URL: Changelog, https://github.com/socrabs151/frontedge-ml/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/socrabs151/frontedge-ml/blob/main/docs/integration.md
+Author: socrabs151
+License: MIT
+License-File: LICENSE
+Keywords: dashboard,evaluation,experiments,fastapi,ml,mlops,runs
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.115
+Requires-Dist: pydantic>=2.9
+Description-Content-Type: text/markdown
+
+# frontedge
+
+The frontend layer for ML engineering: a ready-made design system and screens that mount into
+any FastAPI application.
+
+```python
+from fastapi import FastAPI
+import frontedge
+
+app = FastAPI()
+app.include_router(frontedge.runs(runs_provider=my_provider))
+```
+
+The provider returns `frontedge.Run` objects; the library knows nothing about authentication and
+hands the `request` to the provider, so access control stays on the application side.
+
+## What's inside
+
+- `frontedge.mount(runs_provider, evals=..., datasets=..., actions=..., config=..., path="/frontedge")`
+  — the router: the list of runs, the run details, the log stream (SSE), the metadata and the
+  built interface.
+- `frontedge.runs(runs_provider, path="/frontedge")` — the same router without the eval and
+  dataset screens.
+- `frontedge.models` — the domain model: `Run`, `Stage`, `MetricPoint`, `Artifact`, `Example`,
+  `LogLine`, `EvalSummary`, `EvalComparison`, `DatasetInfo`, `DatasetDetail`, the statuses and
+  the freshness.
+- `frontedge gen --out src/generated` — the generator of TypeScript types and a typed client
+  from the pydantic models. Pure Python, no Node needed.
+
+One process, one port: the interface and the API are served by the same app.
+
+## Configuration
+
+The configuration is data, not code — a TOML or JSON file that the same interface can edit by
+hand, from code and later with a visual editor:
+
+```toml
+# frontedge.toml
+density = "default"          # compact | default | comfortable
+theme = "light"              # light | dark
+run_columns = ["name", "status", "ribbon", "dataset", "startedAt", "durationMs", "accuracy", "loss"]
+```
+
+```python
+app.include_router(frontedge.mount(my_runs_provider, config="frontedge.toml"))
+```
+
+`UiConfig` also knows `eval_tabs`, `actions`, `live_refresh_seconds`, `baseline_run` and
+`page_size`. The configuration is served to the browser as `GET /frontedge/api/config`.
+
+## Actions
+
+The interface never invents what a button does: a project declares the actions it supports, and
+the library calls them.
+
+```toml
+[[actions]]
+id = "stop"
+label = "Stop"
+placement = "run"        # run | runs | evals | datasets
+danger = true
+```
+
+```python
+from frontedge import ActionResult
+
+async def stop_run(request, payload) -> ActionResult:
+    run_id = payload["runId"]
+    await my_repository.stop(run_id)
+    return ActionResult(ok=True, message=f"Run {run_id} stopped")
+
+app.include_router(
+    frontedge.mount(my_runs_provider, actions={"stop": stop_run}, config="frontedge.toml")
+)
+```
+
+The handler receives the `request` and the `payload` of the interface and returns an
+`ActionResult`; its `message` is shown to the user.
+
+The full description of the product and of the visual language:
+[design document](https://github.com/socrabs151/frontedge-ml/blob/main/docs/specs/2026-10-20-frontedge-design.md).
+The full contract: [docs/integration.md](https://github.com/socrabs151/frontedge-ml/blob/main/docs/integration.md).
+
+MIT.

frontedge-0.1.0/README.md

@@ -0,0 +1,84 @@
+# frontedge
+
+The frontend layer for ML engineering: a ready-made design system and screens that mount into
+any FastAPI application.
+
+```python
+from fastapi import FastAPI
+import frontedge
+
+app = FastAPI()
+app.include_router(frontedge.runs(runs_provider=my_provider))
+```
+
+The provider returns `frontedge.Run` objects; the library knows nothing about authentication and
+hands the `request` to the provider, so access control stays on the application side.
+
+## What's inside
+
+- `frontedge.mount(runs_provider, evals=..., datasets=..., actions=..., config=..., path="/frontedge")`
+  — the router: the list of runs, the run details, the log stream (SSE), the metadata and the
+  built interface.
+- `frontedge.runs(runs_provider, path="/frontedge")` — the same router without the eval and
+  dataset screens.
+- `frontedge.models` — the domain model: `Run`, `Stage`, `MetricPoint`, `Artifact`, `Example`,
+  `LogLine`, `EvalSummary`, `EvalComparison`, `DatasetInfo`, `DatasetDetail`, the statuses and
+  the freshness.
+- `frontedge gen --out src/generated` — the generator of TypeScript types and a typed client
+  from the pydantic models. Pure Python, no Node needed.
+
+One process, one port: the interface and the API are served by the same app.
+
+## Configuration
+
+The configuration is data, not code — a TOML or JSON file that the same interface can edit by
+hand, from code and later with a visual editor:
+
+```toml
+# frontedge.toml
+density = "default"          # compact | default | comfortable
+theme = "light"              # light | dark
+run_columns = ["name", "status", "ribbon", "dataset", "startedAt", "durationMs", "accuracy", "loss"]
+```
+
+```python
+app.include_router(frontedge.mount(my_runs_provider, config="frontedge.toml"))
+```
+
+`UiConfig` also knows `eval_tabs`, `actions`, `live_refresh_seconds`, `baseline_run` and
+`page_size`. The configuration is served to the browser as `GET /frontedge/api/config`.
+
+## Actions
+
+The interface never invents what a button does: a project declares the actions it supports, and
+the library calls them.
+
+```toml
+[[actions]]
+id = "stop"
+label = "Stop"
+placement = "run"        # run | runs | evals | datasets
+danger = true
+```
+
+```python
+from frontedge import ActionResult
+
+async def stop_run(request, payload) -> ActionResult:
+    run_id = payload["runId"]
+    await my_repository.stop(run_id)
+    return ActionResult(ok=True, message=f"Run {run_id} stopped")
+
+app.include_router(
+    frontedge.mount(my_runs_provider, actions={"stop": stop_run}, config="frontedge.toml")
+)
+```
+
+The handler receives the `request` and the `payload` of the interface and returns an
+`ActionResult`; its `message` is shown to the user.
+
+The full description of the product and of the visual language:
+[design document](https://github.com/socrabs151/frontedge-ml/blob/main/docs/specs/2026-10-20-frontedge-design.md).
+The full contract: [docs/integration.md](https://github.com/socrabs151/frontedge-ml/blob/main/docs/integration.md).
+
+MIT.

frontedge-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[project]
+name = "frontedge"
+version = "0.1.0"
+description = "Frontend layer for ML engineering: mount ready-made screens into any FastAPI app"
+readme = "README.md"
+requires-python = ">=3.11"
+authors = [{ name = "socrabs151" }]
+keywords = ["ml", "mlops", "fastapi", "experiments", "dashboard", "runs", "evaluation"]
+license = { text = "MIT" }
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: FastAPI",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dependencies = [
+    "fastapi>=0.115",
+    "pydantic>=2.9",
+]
+
+[project.urls]
+Homepage = "https://github.com/socrabs151/frontedge-ml"
+Repository = "https://github.com/socrabs151/frontedge-ml"
+Issues = "https://github.com/socrabs151/frontedge-ml/issues"
+Changelog = "https://github.com/socrabs151/frontedge-ml/blob/main/CHANGELOG.md"
+Documentation = "https://github.com/socrabs151/frontedge-ml/blob/main/docs/integration.md"
+
+[project.scripts]
+frontedge = "frontedge.cli:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/frontedge"]
+# The built interface is copied into src/frontedge/static (build: pnpm build && pnpm build:ui)
+artifacts = ["src/frontedge/static/**"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[tool.mypy]
+python_version = "3.11"
+mypy_path = "src"
+plugins = ["pydantic.mypy"]
+ignore_missing_imports = true
+
+[dependency-groups]
+dev = [
+    "httpx>=0.27",
+    "mypy>=1.11",
+    "pytest>=8.0",
+    "ruff>=0.6",
+]

frontedge-0.1.0/src/frontedge/__init__.py

@@ -0,0 +1,75 @@
+"""Frontedge — the frontend layer for ML engineering.
+
+    from fastapi import FastAPI
+    import frontedge
+
+    app = FastAPI()
+    app.include_router(frontedge.mount(my_runs_provider))
+"""
+
+from .config import ActionResult, ActionSpec, ColumnSpec, MetricSpec, UiConfig, load_config
+from .models import (
+    Artifact,
+    DatasetDetail,
+    DatasetInfo,
+    EvalComparison,
+    EvalSummary,
+    Example,
+    ExampleResult,
+    Freshness,
+    LogLine,
+    MetricDirection,
+    MetricEvent,
+    MetricPoint,
+    ProvenanceEntry,
+    Run,
+    RunStatus,
+    Stage,
+    StageName,
+    role,
+)
+from .providers import (
+    CallableProvider,
+    DatasetProvider,
+    EvalProvider,
+    FrontedgeProvider,
+    ProviderError,
+)
+from .screens import mount, runs
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "ActionResult",
+    "ActionSpec",
+    "Artifact",
+    "CallableProvider",
+    "ColumnSpec",
+    "DatasetDetail",
+    "DatasetInfo",
+    "DatasetProvider",
+    "EvalComparison",
+    "EvalProvider",
+    "EvalSummary",
+    "Example",
+    "ExampleResult",
+    "Freshness",
+    "FrontedgeProvider",
+    "LogLine",
+    "MetricDirection",
+    "MetricEvent",
+    "MetricSpec",
+    "MetricPoint",
+    "ProviderError",
+    "ProvenanceEntry",
+    "Run",
+    "RunStatus",
+    "Stage",
+    "StageName",
+    "UiConfig",
+    "load_config",
+    "__version__",
+    "mount",
+    "role",
+    "runs",
+]