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

dashboard/__init__.py

@@ -0,0 +1 @@
+"""Dashboard module."""

dashboard/endpoints/api.py

@@ -0,0 +1,17 @@
+"""REST API endpoints for the Dashboard module."""
+
+from __future__ import annotations
+
+from fastapi import APIRouter, Depends, Request
+from simple_module_db.deps import get_db
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from dashboard.stats import fetch_dashboard_stats
+
+router = APIRouter()
+
+
+@router.get("/stats")
+async def dashboard_stats(request: Request, db: AsyncSession = Depends(get_db)) -> dict:
+    """Return dashboard statistics including user counts and system info."""
+    return await fetch_dashboard_stats(db, request.app)

dashboard/endpoints/views.py

@@ -0,0 +1,36 @@
+"""Inertia view endpoints for the Dashboard.
+
+Mounted under ``/dashboard`` via :attr:`DashboardModule.meta.view_prefix`.
+The public landing page at ``/`` is owned by the host, not this module.
+"""
+
+from __future__ import annotations
+
+from fastapi import APIRouter, Depends, Request
+from inertia import InertiaResponse
+from simple_module_db.deps import get_db
+from simple_module_hosting.i18n_deps import TranslatorDep
+from simple_module_hosting.inertia_deps import InertiaDep
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from dashboard.stats import fetch_dashboard_stats
+
+router = APIRouter()
+
+
+@router.get("/", response_model=None)
+async def dashboard(
+    request: Request,
+    inertia: InertiaDep,
+    t: TranslatorDep,
+    db: AsyncSession = Depends(get_db),
+) -> InertiaResponse:
+    """Authenticated dashboard — requires login (enforced by AuthMiddleware)."""
+    stats = await fetch_dashboard_stats(db, request.app)
+    return await inertia.render(
+        "Dashboard/Home",
+        {
+            "welcome": t.t("dashboard.home.welcome_message"),
+            **stats,
+        },
+    )

dashboard/locales/en.json

@@ -0,0 +1,21 @@
+{
+  "home": {
+    "title": "Dashboard",
+    "description": "Overview of your application",
+    "stats": {
+      "total_users": "Total Users",
+      "active_users": "Active Users (7d)",
+      "products": "Products",
+      "modules": "Modules"
+    },
+    "system_info_title": "System",
+    "system_info": {
+      "modules": "Modules",
+      "python_version": "Python Version",
+      "health_checks": "Health Checks"
+    },
+    "welcome_card_title": "Welcome",
+    "welcome_message": "Welcome to SimpleModule",
+    "description_body": "This is a modular monolith built with FastAPI, Inertia.js, and React. Each module provides its own pages, API endpoints, and database schema."
+  }
+}

dashboard/locales/es.json

@@ -0,0 +1,21 @@
+{
+  "home": {
+    "title": "Panel",
+    "description": "Resumen de tu aplicación",
+    "stats": {
+      "total_users": "Usuarios Totales",
+      "active_users": "Usuarios Activos (7d)",
+      "products": "Productos",
+      "modules": "Módulos"
+    },
+    "system_info_title": "Sistema",
+    "system_info": {
+      "modules": "Módulos",
+      "python_version": "Versión de Python",
+      "health_checks": "Verificaciones de Salud"
+    },
+    "welcome_card_title": "Bienvenido",
+    "welcome_message": "Bienvenido a SimpleModule",
+    "description_body": "Este es un monolito modular construido con FastAPI, Inertia.js y React. Cada módulo proporciona sus propias páginas, endpoints de API y esquema de base de datos."
+  }
+}

dashboard/module.py

@@ -0,0 +1,45 @@
+"""Dashboard module definition."""
+
+from __future__ import annotations
+
+import importlib.resources
+from pathlib import Path
+
+from fastapi import APIRouter
+from simple_module_core.menu import MenuItem, MenuRegistry, MenuSection
+from simple_module_core.module import ModuleBase, ModuleMeta
+
+_MODULE_PRODUCTS = "Products"
+_MODULE_USERS = "Users"
+_URL_DASHBOARD = "/dashboard/"
+_ICON_DASHBOARD = "home"
+
+
+class DashboardModule(ModuleBase):
+    meta = ModuleMeta(
+        name="Dashboard",
+        route_prefix="/api/dashboard",
+        view_prefix="/dashboard",
+        depends_on=[_MODULE_PRODUCTS, _MODULE_USERS],
+    )
+
+    def register_routes(self, api_router: APIRouter, view_router: APIRouter) -> None:
+        from dashboard.endpoints.api import router as api
+        from dashboard.endpoints.views import router as views
+
+        api_router.include_router(api)
+        view_router.include_router(views)
+
+    def register_menu_items(self, registry: MenuRegistry) -> None:
+        registry.add(
+            MenuItem(
+                label="Dashboard",
+                url=_URL_DASHBOARD,
+                icon=_ICON_DASHBOARD,
+                order=1,
+                section=MenuSection.SIDEBAR,
+            )
+        )
+
+    def locale_dirs(self) -> dict[str, Path]:
+        return {"dashboard": Path(str(importlib.resources.files(__package__) / "locales"))}

dashboard/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@simple-module-py/dashboard",
+  "version": "0.1.0",
+  "private": true,
+  "description": "Frontend assets for the Dashboard module",
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "@inertiajs/react": "^2.0.0",
+    "@simple-module-py/ui": "*"
+  },
+  "devDependencies": {
+    "@simple-module-py/tsconfig": "*"
+  },
+  "dependencies": {}
+}

dashboard/pages/Home.tsx

@@ -0,0 +1,186 @@
+import { usePage } from '@inertiajs/react';
+import { keys, useT } from '@simple-module-py/i18n';
+import { PageShell } from '@simple-module-py/ui/components/PageShell';
+import { Card, CardContent, CardHeader, CardTitle } from '@simple-module-py/ui/components/ui/card';
+import { Table, TableBody, TableCell, TableRow } from '@simple-module-py/ui/components/ui/table';
+import { AuthenticatedLayout } from '@simple-module-py/ui/layouts/AuthenticatedLayout';
+import { Activity, Box, Heart, Package, Server, Users } from 'lucide-react';
+
+type Accent = 'primary' | 'emerald' | 'violet' | 'amber';
+
+const HEALTH_STATUS_COLOR: Record<string, string> = {
+  healthy: 'bg-emerald-500',
+  degraded: 'bg-amber-500',
+  unhealthy: 'bg-red-500',
+};
+
+interface SystemModule {
+  name: string;
+  status: 'loaded';
+}
+
+interface HealthCheck {
+  name: string;
+  status: 'healthy' | 'degraded' | 'unhealthy';
+}
+
+interface SystemInfo {
+  modules: SystemModule[];
+  python_version: string;
+  health_checks: HealthCheck[];
+}
+
+interface Props {
+  total_users: number;
+  active_users_7d: number;
+  total_products: number;
+  module_count: number;
+  system_info: SystemInfo;
+}
+
+function Home() {
+  const props = usePage<{ props: Props }>().props as unknown as Props;
+  const { t } = useT();
+
+  return (
+    <PageShell
+      title={t(keys.dashboard.home.title)}
+      description={t(keys.dashboard.home.description)}
+    >
+      <div className="grid grid-cols-1 sm:grid-cols-2 md:grid-cols-4 gap-5 mb-8">
+        <StatCard
+          title={t(keys.dashboard.home.stats.total_users)}
+          value={String(props.total_users)}
+          icon={<Users className="size-4" />}
+          accent="emerald"
+        />
+        <StatCard
+          title={t(keys.dashboard.home.stats.active_users)}
+          value={String(props.active_users_7d)}
+          icon={<Activity className="size-4" />}
+          accent="amber"
+        />
+        <StatCard
+          title={t(keys.dashboard.home.stats.products)}
+          value={String(props.total_products)}
+          icon={<Package className="size-4" />}
+          accent="primary"
+        />
+        <StatCard
+          title={t(keys.dashboard.home.stats.modules)}
+          value={String(props.module_count)}
+          icon={<Box className="size-4" />}
+          accent="violet"
+        />
+      </div>
+
+      <Card>
+        <CardHeader>
+          <CardTitle className="flex items-center gap-2 font-[var(--font-display)]">
+            <Server className="size-4" />
+            {t(keys.dashboard.home.system_info_title)}
+          </CardTitle>
+        </CardHeader>
+        <CardContent className="space-y-6">
+          <div>
+            <h4 className="text-sm font-medium text-muted-foreground mb-2">
+              {t(keys.dashboard.home.system_info.modules)}
+            </h4>
+            <div className="flex flex-wrap gap-2">
+              {props.system_info.modules.map((mod) => (
+                <span
+                  key={mod.name}
+                  className="inline-flex items-center gap-1.5 rounded-md border px-2.5 py-1 text-xs font-medium"
+                >
+                  <span className="size-1.5 rounded-full bg-emerald-500" />
+                  {mod.name}
+                </span>
+              ))}
+            </div>
+          </div>
+
+          <Table>
+            <TableBody>
+              <TableRow>
+                <TableCell className="font-medium text-muted-foreground">
+                  {t(keys.dashboard.home.system_info.python_version)}
+                </TableCell>
+                <TableCell>{props.system_info.python_version}</TableCell>
+              </TableRow>
+              {props.system_info.health_checks.map((check) => (
+                <TableRow key={check.name}>
+                  <TableCell className="font-medium text-muted-foreground flex items-center gap-2">
+                    <Heart className="size-3" />
+                    {check.name}
+                  </TableCell>
+                  <TableCell>
+                    <span className="inline-flex items-center gap-1.5">
+                      <span
+                        className={`size-2 rounded-full ${HEALTH_STATUS_COLOR[check.status] ?? 'bg-red-500'}`}
+                      />
+                      {check.status}
+                    </span>
+                  </TableCell>
+                </TableRow>
+              ))}
+            </TableBody>
+          </Table>
+        </CardContent>
+      </Card>
+    </PageShell>
+  );
+}
+
+function StatCard({
+  title,
+  value,
+  icon,
+  accent,
+}: {
+  title: string;
+  value: string;
+  icon: React.ReactNode;
+  accent: Accent;
+}) {
+  const styles: Record<Accent, { card: string; icon: string; value: string }> = {
+    primary: {
+      card: 'border-primary-200 bg-gradient-to-br from-primary-50 to-card',
+      icon: 'text-primary-500 bg-primary-100',
+      value: 'text-primary-900',
+    },
+    emerald: {
+      card: 'border-emerald-border bg-gradient-to-br from-emerald-bg to-card',
+      icon: 'text-emerald-icon-fg bg-emerald-icon-bg',
+      value: 'text-emerald-value',
+    },
+    violet: {
+      card: 'border-violet-border bg-gradient-to-br from-violet-bg to-card',
+      icon: 'text-violet-icon-fg bg-violet-icon-bg',
+      value: 'text-violet-value',
+    },
+    amber: {
+      card: 'border-amber-200 bg-gradient-to-br from-amber-50 to-card',
+      icon: 'text-amber-600 bg-amber-100',
+      value: 'text-amber-900',
+    },
+  };
+
+  const s = styles[accent];
+
+  return (
+    <Card className={s.card}>
+      <CardContent className="pt-5">
+        <div className="flex items-center justify-between mb-3">
+          <span className="text-sm font-medium text-muted-foreground">{title}</span>
+          <div className={`w-8 h-8 rounded-lg flex items-center justify-center ${s.icon}`}>
+            {icon}
+          </div>
+        </div>
+        <p className={`text-3xl font-bold font-[var(--font-display)] ${s.value}`}>{value}</p>
+      </CardContent>
+    </Card>
+  );
+}
+
+Home.layout = (page: React.ReactNode) => <AuthenticatedLayout>{page}</AuthenticatedLayout>;
+export default Home;

dashboard/stats.py

@@ -0,0 +1,114 @@
+"""Dashboard statistics queries with TTL-based caching."""
+
+from __future__ import annotations
+
+import asyncio
+import sys
+import time
+from datetime import UTC, datetime, timedelta
+
+from fastapi import FastAPI
+from products.models import Product
+from simple_module_core.health import HealthCheck, HealthStatus
+from sqlalchemy import func, select
+from sqlalchemy.ext.asyncio import AsyncSession
+from users.models import User
+
+_CACHE_TTL_SECONDS = 30
+_cache: dict | None = None
+_cache_ts: float = 0.0
+_cache_lock = asyncio.Lock()
+
+
+def _cache_hit() -> dict | None:
+    if _cache is not None and (time.monotonic() - _cache_ts) < _CACHE_TTL_SECONDS:
+        return _cache.copy()
+    return None
+
+
+async def fetch_dashboard_stats(db: AsyncSession, app: FastAPI) -> dict:
+    """Gather all dashboard statistics, cached for 30 seconds."""
+    global _cache, _cache_ts
+
+    hit = _cache_hit()
+    if hit is not None:
+        return hit
+
+    async with _cache_lock:
+        # Re-check after acquiring lock — another coroutine may have refreshed.
+        hit = _cache_hit()
+        if hit is not None:
+            return hit
+
+        total_users = await _count_users(db)
+        active_users_7d = await _count_active_users(db, days=7)
+        total_products = await _count_products(db)
+        modules_list = _get_module_info(app)
+        health_checks = await _run_health_checks(app)
+
+        result = {
+            "total_users": total_users,
+            "active_users_7d": active_users_7d,
+            "total_products": total_products,
+            "module_count": len(modules_list),
+            "system_info": {
+                "modules": modules_list,
+                "python_version": (
+                    f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
+                ),
+                "health_checks": health_checks,
+            },
+        }
+
+        _cache = result
+        _cache_ts = time.monotonic()
+        return result.copy()
+
+
+def invalidate_stats_cache() -> None:
+    """Clear the stats cache — useful for testing or after data mutations."""
+    global _cache, _cache_ts
+    _cache = None
+    _cache_ts = 0.0
+
+
+async def _count_users(db: AsyncSession) -> int:
+    result = await db.execute(select(func.count()).select_from(User))
+    return result.scalar_one()
+
+
+async def _count_active_users(db: AsyncSession, *, days: int) -> int:
+    cutoff = datetime.now(UTC) - timedelta(days=days)
+    result = await db.execute(
+        select(func.count()).select_from(User).where(User.last_login_at >= cutoff)
+    )
+    return result.scalar_one()
+
+
+async def _count_products(db: AsyncSession) -> int:
+    result = await db.execute(
+        select(func.count()).select_from(Product).where(Product.is_active.is_(True))
+    )
+    return result.scalar_one()
+
+
+def _get_module_info(app: FastAPI) -> list[dict[str, str]]:
+    # Reads from the module list discovered once at startup, avoiding
+    # expensive entry-point rescans on every request.
+    return [{"name": m.meta.name, "status": "loaded"} for m in app.state.sm.modules]
+
+
+async def _run_health_checks(app: FastAPI) -> list[dict[str, str]]:
+    registry = app.state.sm.health_registry
+    checks = registry.all_checks
+    if not checks:
+        return []
+
+    async def _run_one(check: HealthCheck) -> dict[str, str]:
+        try:
+            result = await check.check()
+            return {"name": check.name, "status": result.status.value}
+        except Exception:
+            return {"name": check.name, "status": HealthStatus.UNHEALTHY.value}
+
+    return list(await asyncio.gather(*[_run_one(c) for c in checks]))

simple_module_dashboard-0.0.1.dist-info/METADATA

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: simple_module_dashboard
+Version: 0.0.1
+Summary: Admin landing page and sidebar menu host for authenticated users of a simple_module app
+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,dashboard,inertia,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
+Requires-Dist: simple-module-products==0.0.1
+Requires-Dist: simple-module-users==0.0.1
+Description-Content-Type: text/markdown
+
+# simple_module_dashboard
+
+Admin landing page + sidebar menu host for authenticated users of a [simple_module](https://github.com/antosubash/simple_module_python) app. Renders `/dashboard`, collects menu entries registered by every other installed module, and provides the primary Inertia layout.
+
+Pre-wired into any app scaffolded with `simple-module new`.
+
+## Install
+
+```bash
+pip install simple_module_dashboard
+```
+
+## What it provides
+
+- `/dashboard` Inertia view, a single entry point for logged-in users.
+- Global sidebar renderer — aggregates `register_menu_items()` calls from all modules into one tree.
+- Breadcrumb + page-title provider used by downstream module pages.
+
+## Usage
+
+Install the module in a host, and any other module can register a menu entry:
+
+```python
+# modules/orders/orders/module.py
+from simple_module_core import ModuleBase, ModuleMeta
+from simple_module_core.menus import MenuItem
+
+
+class OrdersModule(ModuleBase):
+    meta = ModuleMeta(name="orders")
+
+    def register_menu_items(self):
+        return [MenuItem(label="Orders", href="/orders", icon="shopping-bag")]
+```
+
+The dashboard sidebar picks it up automatically.
+
+## Depends on
+
+- `simple_module_core`, `simple_module_db`, `simple_module_hosting`
+- `simple_module_users`, `simple_module_products` (demo content used by the default layout)
+
+## License
+
+MIT — see [LICENSE](https://github.com/antosubash/simple_module_python/blob/main/LICENSE).

simple_module_dashboard-0.0.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+dashboard/__init__.py,sha256=5c12Gf0Ehk8pjWvVP5stItAp63wtIRZB7yMY7ibZD44,24
+dashboard/module.py,sha256=KfS1mWeA8DW4CJMLrgZyX-cvlj0UZ5eIh-fuRJcWips,1361
+dashboard/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dashboard/stats.py,sha256=eu1ygZeLhCiU_J_y7gsIF5w9aCfI-KWGSb16j7Gv2k4,3607
+dashboard/endpoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dashboard/endpoints/api.py,sha256=WPbzlnrByyr4cJBo51nNPhJMCVeOk09cnKC9igAD78A,544
+dashboard/endpoints/views.py,sha256=lXGJ5-LLE9FtMZG0oP7UMDiIK9ustbjM-as0xfGCfGc,1097
+dashboard/locales/en.json,sha256=uKLPMP5wIT6SbaLhanHZxDL_Uui5u4vDkZx3clopU3g,682
+dashboard/locales/es.json,sha256=FVnhG-mCKhZcWlahBxufV6Z1NgYHJG0QP3-19Uen5cw,729
+dashboard/pages/Home.tsx,sha256=6VmmjukBooSt6XQvrXpaafTJMJd3IpnJ5ou5ATOyrHM,6034
+dashboard/package.json,sha256=rQk8G963uVGfmSjghde11OPEBgQrLfb7GpdKvibY-nU,381
+simple_module_dashboard-0.0.1.dist-info/METADATA,sha256=0IBgXU7qYPohMhYHhKDbKmq4SD7FRsrrGJrZcAi86oI,2817
+simple_module_dashboard-0.0.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+simple_module_dashboard-0.0.1.dist-info/entry_points.txt,sha256=ZETTXF8ULqw2Xv-nwuSEab5dgtdCsa2h6tITh6HwAEg,61
+simple_module_dashboard-0.0.1.dist-info/licenses/LICENSE,sha256=Yn66lhLklsF5p7pa85_ksQrJ79Q-FgOaUAHevLBjer4,1068
+simple_module_dashboard-0.0.1.dist-info/RECORD,,

simple_module_dashboard-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_dashboard-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[simple_module]
+dashboard = dashboard.module:DashboardModule

simple_module_dashboard-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.