openadmin-dev 0.6.2__tar.gz → 0.7.3__tar.gz

{openadmin_dev-0.6.2 → openadmin_dev-0.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openadmin-dev
-Version: 0.6.2
+Version: 0.7.3
 Summary: Add your description here
 Project-URL: Homepage, https://github.com/openadmin-team/openadmin-py
 Project-URL: Issues, https://github.com/openadmin-team/openadmin-py/issues

{openadmin_dev-0.6.2 → openadmin_dev-0.7.3}/examples/admin/analytics.py

@@ -4,6 +4,7 @@
 
 from sqlalchemy import func, select
 
+from openadmin import spec
 from openadmin.fastapi import AdminPage
 
 from ..lib import models
@@ -17,13 +18,13 @@ page = AdminPage(
 
 
 @page.stat("Earliest Publication")
-async def get_earliest_publication(session: AsyncSessionDep) -> int | str:
+async def get_earliest_publication(session: AsyncSessionDep) -> spec.Stat:
     result = await session.execute(
         select(func.min(models.Book.published_year)).where(
             models.Book.published_year.isnot(None)
         )
     )
-    return result.scalar_one_or_none() or "N/A"
+    return {"value": result.scalar_one_or_none() or "N/A", "icon": "sun-medium"}
 
 
 @page.stat("Latest Publication")

{openadmin_dev-0.6.2 → openadmin_dev-0.7.3}/examples/admin/authors.py

@@ -5,6 +5,7 @@
 from pydantic import BaseModel
 from sqlalchemy import func, select
 
+from openadmin import spec
 from openadmin.fastapi import AdminPage
 from openadmin.fastapi.deps import PageDep, SearchQueryDep
 
@@ -19,9 +20,9 @@ page = AdminPage(
 
 
 @page.stat("Total Authors")
-async def get_total_authors(session: AsyncSessionDep) -> int:
+async def get_total_authors(session: AsyncSessionDep) -> spec.StatResponse:
     result = await session.execute(select(func.count(models.Author.id)))
-    return result.scalar_one()
+    return {"value": result.scalar_one(), "icon": "sun"}
 
 
 @page.stat("Authors with Bio")

{openadmin_dev-0.6.2 → openadmin_dev-0.7.3}/openadmin/fastapi/admin_page.py

@@ -53,9 +53,11 @@ class AdminPage:
 
             if isinstance(item, Stat):
                 components.append(
-                    spec.Stat(
+                    spec.StatComponent(
                         type="stat",
                         id=item.id,
+                        color=item.color,
+                        icon=item.icon,
                         name=item.name,
                         description=item.description,
                         method=item.method,
@@ -222,6 +224,8 @@ class AdminPage:
         self,
         name: str,
         *,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
         description: str | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
@@ -229,6 +233,8 @@ class AdminPage:
         item = Stat(
             function_name=unique_name,
             method="get",
+            color=color,
+            icon=icon,
             name=name,
             description=description,
             id=kebab_name,

{openadmin_dev-0.6.2 → openadmin_dev-0.7.3}/openadmin/fastapi/stat.py

@@ -13,6 +13,8 @@ class Stat:
     function_name: str
     method: spec.HttpMethod
     id: str
+    icon: spec.Icon | None
+    color: spec.Color | None
     name: str
     description: str | None
     func: Callable | None = field(default=None)

{openadmin_dev-0.6.2 → openadmin_dev-0.7.3}/openadmin/spec/__init__.py

@@ -5,6 +5,7 @@
 from .action import Action
 from .area_chart import AreaChart
 from .bar_chart import BarChart
+from .colors import Color
 from .component import Component
 from .form import Form
 from .http_methods import HttpMethod
@@ -17,7 +18,7 @@ from .property import Property
 from .property_type import PropertyType
 from .section import Section
 from .spec import Spec
-from .stat import Stat
+from .stat import Stat, StatComponent, StatResponse, StatValue
 from .table import Table
 
 __all__ = [
@@ -34,8 +35,12 @@ __all__ = [
     "PropertyType",
     "Section",
     "Spec",
-    "Stat",
+    "StatComponent",
     "Table",
     "Markdown",
     "Icon",
+    "StatResponse",
+    "StatValue",
+    "Stat",
+    "Color",
 ]

openadmin_dev-0.7.3/openadmin/spec/colors.py

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from typing import Literal
+
+type Color = Literal[
+    "slate",
+    "gray",
+    "zinc",
+    "neutral",
+    "stone",
+    "red",
+    "orange",
+    "amber",
+    "yellow",
+    "lime",
+    "green",
+    "emerald",
+    "teal",
+    "cyan",
+    "sky",
+    "blue",
+    "indigo",
+    "violet",
+    "purple",
+    "fuchsia",
+    "pink",
+    "rose",
+    "black",
+    "white",
+]

{openadmin_dev-0.6.2 → openadmin_dev-0.7.3}/openadmin/spec/component.py

@@ -11,9 +11,17 @@ from .form import Form
 from .line_chart import LineChart
 from .markdown import Markdown
 from .pie_chart import PieChart
-from .stat import Stat
+from .stat import StatComponent
 from .table import Table
 
 type Component = Union[
-    Stat, Table, AreaChart, BarChart, LineChart, PieChart, Action, Form, Markdown
+    StatComponent,
+    Table,
+    AreaChart,
+    BarChart,
+    LineChart,
+    PieChart,
+    Action,
+    Form,
+    Markdown,
 ]

openadmin_dev-0.7.3/openadmin/spec/stat.py

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from typing import Literal, NotRequired, TypedDict
+
+from pydantic import BaseModel, Field
+
+from .colors import Color
+from .http_methods import HttpMethod
+from .icons import Icon
+from .property import Property
+
+
+class StatComponent(BaseModel):
+    type: Literal["stat"]
+    id: str
+    icon: Icon | None
+    color: Color | None
+    name: str
+    description: str | None
+    url: str
+    method: HttpMethod
+    query: list[Property] | None = Field(None)
+
+
+type StatValue = str | int | float | bool | None
+
+
+class StatResponse(TypedDict):
+    value: StatValue
+    icon: NotRequired[Icon]
+    color: NotRequired[Color]
+
+
+type Stat = StatValue | StatResponse

{openadmin_dev-0.6.2 → openadmin_dev-0.7.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "openadmin-dev"
-version = "0.6.2"
+version = "0.7.3"
 description = "Add your description here"
 authors = [
   { name="Mykyta Kasianenko", email="mykytakasianenko@gmail.com" },

openadmin_dev-0.6.2/openadmin/spec/stat.py

@@ -1,20 +0,0 @@
-# SPDX-FileCopyrightText: 2026 OpenAdmin
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-from typing import Literal
-
-from pydantic import BaseModel, Field
-
-from .http_methods import HttpMethod
-from .property import Property
-
-
-class Stat(BaseModel):
-    type: Literal["stat"]
-    id: str
-    name: str
-    description: str | None
-    url: str
-    method: HttpMethod
-    query: list[Property] | None = Field(None)