openadmin-dev 0.6.3__tar.gz → 0.7.4__tar.gz

openadmin_dev-0.7.4/Makefile

@@ -0,0 +1,45 @@
+fix/license:
+	@ uv run reuse download --all
+	@ uv run reuse annotate --license AGPL-3.0-or-later --copyright "OpenAdmin" --recursive --skip-unrecognised openadmin/
+	@ uv run reuse annotate --license AGPL-3.0-or-later --copyright "OpenAdmin" --recursive --skip-unrecognised tests/
+	@ uv run reuse annotate --license AGPL-3.0-or-later --copyright "OpenAdmin" --recursive --skip-unrecognised examples/
+
+fix/format:
+	@ uv run ruff format .
+
+fix/lint:
+	@ uv run ruff check --fix .
+
+fix: fix/license fix/format fix/lint
+
+check/format:
+	@ uv run ruff format --check .
+
+check/lint:
+	@ uv run ruff check .
+
+check/typing:
+	@ uv run pyright .
+
+check/cves:
+	@ uv audit --preview-features audit
+
+check/security:
+	@ uv run bandit -r openadmin -q
+
+check/unused:
+	@ uv run vulture openadmin --min-confidence 80
+
+check/spell:
+	@ uv run codespell .
+
+check/license:
+	@ uv run reuse lint
+
+check/test:
+	@ uv run pytest
+
+check: check/format check/lint check/typing check/cves check/security check/unused check/spell check/license check/test
+
+dev/run:
+	@ PYTHONPATH=. uv run fastapi dev examples/main.py --host 0.0.0.0 --port $${PORT:-8000} --reload

{openadmin_dev-0.6.3 → openadmin_dev-0.7.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openadmin-dev
-Version: 0.6.3
+Version: 0.7.4
 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
@@ -60,16 +60,21 @@ admin = AdminPanel()
 # Define a page
 page = AdminPage("Dashboard")
 
+
 @page.stat("Total Users")
 async def total_users() -> Stat:
     return Stat(value=1_024)
 
+
 @page.table("Recent Users")
 async def recent_users() -> Table:
-    return Table(data=[
-        {"id": 1, "name": "Alice", "role": "admin"},
-        {"id": 2, "name": "Bob",   "role": "viewer"},
-    ])
+    return Table(
+        data=[
+            {"id": 1, "name": "Alice", "role": "admin"},
+            {"id": 2, "name": "Bob", "role": "viewer"},
+        ]
+    )
+
 
 # Register the page and mount the panel
 admin.include_page(page)
@@ -87,6 +92,7 @@ Display a single numeric or boolean value.
 ```python
 from openadmin.types import Stat
 
+
 @page.stat("Active Sessions")
 async def active_sessions() -> Stat:
     return Stat(value=42)
@@ -100,6 +106,7 @@ Paginated tables with optional search. Use the built-in dependency types to rece
 from openadmin.fastapi import PaginationParamsDep, SearchQueryDep
 from openadmin.types import Table
 
+
 @page.table("Users")
 async def users_table(
     pagination: PaginationParamsDep,
@@ -117,18 +124,23 @@ Attach per-row action buttons by including `__actions__` in each row:
 ```python
 from openadmin.types import Action, Table, TableRow
 
+
 @page.table("Users")
 async def users_table() -> Table:
-    return Table(data=[
-        TableRow(
-            id=1,
-            name="Alice",
-            __actions__=[
-                Action(color="danger", method="DELETE", url="/users/1", body=None),
-                Action(color="info",   method="POST",   url="/users/1/reset", body=None),
-            ],
-        )
-    ])
+    return Table(
+        data=[
+            TableRow(
+                id=1,
+                name="Alice",
+                __actions__=[
+                    Action(color="danger", method="DELETE", url="/users/1", body=None),
+                    Action(
+                        color="info", method="POST", url="/users/1/reset", body=None
+                    ),
+                ],
+            )
+        ]
+    )
 ```
 
 ### Charts
@@ -138,6 +150,7 @@ All chart types share the same structure: a `data` list of dicts and a `config`
 ```python
 from openadmin.types import BarChart, PieChart
 
+
 @page.bar_chart("Sales by Region", "Total sales per region this quarter")
 async def sales_chart() -> BarChart:
     return BarChart(
@@ -148,11 +161,12 @@ async def sales_chart() -> BarChart:
         config={"sales": {"label": "Sales", "color": "#6366f1"}},
     )
 
+
 @page.pie_chart("User Roles", "Breakdown of user roles")
 async def roles_chart() -> PieChart:
     return PieChart(
         data=[
-            {"segment": "Admin",  "count": 5},
+            {"segment": "Admin", "count": 5},
             {"segment": "Editor", "count": 20},
             {"segment": "Viewer", "count": 75},
         ],
@@ -178,10 +192,12 @@ Forms collect user input and submit it to your endpoint. Mark a form hidden if i
 ```python
 from pydantic import BaseModel
 
+
 class InvitePayload(BaseModel):
     email: str
     role: str
 
+
 @page.form_post("Invite User", "Send an invitation email to a new user")
 async def invite_user(payload: InvitePayload):
     # send invite...
@@ -209,27 +225,37 @@ from openadmin.types import Stat, Table, BarChart
 
 page = AdminPage("Library")
 
+
 @page.stat("Total Books")
 async def total_books(session: AsyncSessionDep) -> Stat:
     result = await session.execute(select(func.count()).select_from(Book))
     return Stat(value=result.scalar_one())
 
+
 @page.table("Books")
 async def books_table(
     session: AsyncSessionDep,
     pagination: PaginationParamsDep,
     search: SearchQueryDep,
 ) -> Table:
-    stmt = select(Book).offset(pagination.page * pagination.per_page).limit(pagination.per_page)
+    stmt = (
+        select(Book)
+        .offset(pagination.page * pagination.per_page)
+        .limit(pagination.per_page)
+    )
     books = (await session.execute(stmt)).scalars().all()
     return Table(data=[{"title": b.title, "year": b.published_year} for b in books])
 
+
 @page.bar_chart("Books per Genre", "Number of books in each genre")
 async def books_per_genre(session: AsyncSessionDep) -> BarChart:
-    rows = (await session.execute(
-        select(Genre.name, func.count().label("books"))
-        .join(BookToGenre).group_by(Genre.id)
-    )).all()
+    rows = (
+        await session.execute(
+            select(Genre.name, func.count().label("books"))
+            .join(BookToGenre)
+            .group_by(Genre.id)
+        )
+    ).all()
     return BarChart(
         data=[{"genre": name, "books": count} for name, count in rows],
         config={"books": {"label": "Books", "color": "#6366f1"}},

{openadmin_dev-0.6.3 → openadmin_dev-0.7.4}/README.md

@@ -45,16 +45,21 @@ admin = AdminPanel()
 # Define a page
 page = AdminPage("Dashboard")
 
+
 @page.stat("Total Users")
 async def total_users() -> Stat:
     return Stat(value=1_024)
 
+
 @page.table("Recent Users")
 async def recent_users() -> Table:
-    return Table(data=[
-        {"id": 1, "name": "Alice", "role": "admin"},
-        {"id": 2, "name": "Bob",   "role": "viewer"},
-    ])
+    return Table(
+        data=[
+            {"id": 1, "name": "Alice", "role": "admin"},
+            {"id": 2, "name": "Bob", "role": "viewer"},
+        ]
+    )
+
 
 # Register the page and mount the panel
 admin.include_page(page)
@@ -72,6 +77,7 @@ Display a single numeric or boolean value.
 ```python
 from openadmin.types import Stat
 
+
 @page.stat("Active Sessions")
 async def active_sessions() -> Stat:
     return Stat(value=42)
@@ -85,6 +91,7 @@ Paginated tables with optional search. Use the built-in dependency types to rece
 from openadmin.fastapi import PaginationParamsDep, SearchQueryDep
 from openadmin.types import Table
 
+
 @page.table("Users")
 async def users_table(
     pagination: PaginationParamsDep,
@@ -102,18 +109,23 @@ Attach per-row action buttons by including `__actions__` in each row:
 ```python
 from openadmin.types import Action, Table, TableRow
 
+
 @page.table("Users")
 async def users_table() -> Table:
-    return Table(data=[
-        TableRow(
-            id=1,
-            name="Alice",
-            __actions__=[
-                Action(color="danger", method="DELETE", url="/users/1", body=None),
-                Action(color="info",   method="POST",   url="/users/1/reset", body=None),
-            ],
-        )
-    ])
+    return Table(
+        data=[
+            TableRow(
+                id=1,
+                name="Alice",
+                __actions__=[
+                    Action(color="danger", method="DELETE", url="/users/1", body=None),
+                    Action(
+                        color="info", method="POST", url="/users/1/reset", body=None
+                    ),
+                ],
+            )
+        ]
+    )
 ```
 
 ### Charts
@@ -123,6 +135,7 @@ All chart types share the same structure: a `data` list of dicts and a `config`
 ```python
 from openadmin.types import BarChart, PieChart
 
+
 @page.bar_chart("Sales by Region", "Total sales per region this quarter")
 async def sales_chart() -> BarChart:
     return BarChart(
@@ -133,11 +146,12 @@ async def sales_chart() -> BarChart:
         config={"sales": {"label": "Sales", "color": "#6366f1"}},
     )
 
+
 @page.pie_chart("User Roles", "Breakdown of user roles")
 async def roles_chart() -> PieChart:
     return PieChart(
         data=[
-            {"segment": "Admin",  "count": 5},
+            {"segment": "Admin", "count": 5},
             {"segment": "Editor", "count": 20},
             {"segment": "Viewer", "count": 75},
         ],
@@ -163,10 +177,12 @@ Forms collect user input and submit it to your endpoint. Mark a form hidden if i
 ```python
 from pydantic import BaseModel
 
+
 class InvitePayload(BaseModel):
     email: str
     role: str
 
+
 @page.form_post("Invite User", "Send an invitation email to a new user")
 async def invite_user(payload: InvitePayload):
     # send invite...
@@ -194,27 +210,37 @@ from openadmin.types import Stat, Table, BarChart
 
 page = AdminPage("Library")
 
+
 @page.stat("Total Books")
 async def total_books(session: AsyncSessionDep) -> Stat:
     result = await session.execute(select(func.count()).select_from(Book))
     return Stat(value=result.scalar_one())
 
+
 @page.table("Books")
 async def books_table(
     session: AsyncSessionDep,
     pagination: PaginationParamsDep,
     search: SearchQueryDep,
 ) -> Table:
-    stmt = select(Book).offset(pagination.page * pagination.per_page).limit(pagination.per_page)
+    stmt = (
+        select(Book)
+        .offset(pagination.page * pagination.per_page)
+        .limit(pagination.per_page)
+    )
     books = (await session.execute(stmt)).scalars().all()
     return Table(data=[{"title": b.title, "year": b.published_year} for b in books])
 
+
 @page.bar_chart("Books per Genre", "Number of books in each genre")
 async def books_per_genre(session: AsyncSessionDep) -> BarChart:
-    rows = (await session.execute(
-        select(Genre.name, func.count().label("books"))
-        .join(BookToGenre).group_by(Genre.id)
-    )).all()
+    rows = (
+        await session.execute(
+            select(Genre.name, func.count().label("books"))
+            .join(BookToGenre)
+            .group_by(Genre.id)
+        )
+    ).all()
     return BarChart(
         data=[{"genre": name, "books": count} for name, count in rows],
         config={"books": {"label": "Books", "color": "#6366f1"}},

{openadmin_dev-0.6.3 → openadmin_dev-0.7.4}/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
@@ -16,27 +17,45 @@ page = AdminPage(
 )
 
 
-@page.stat("Earliest Publication")
-async def get_earliest_publication(session: AsyncSessionDep) -> int | str:
+@page.stat(
+    "Earliest Publication",
+    icon="sun",
+    description="This is earliest publications for the last quorder",
+    color="red",
+)
+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 result.scalar_one_or_none()
 
 
-@page.stat("Latest Publication")
-async def get_latest_publication(session: AsyncSessionDep) -> int | str:
+@page.stat(
+    "Latest Publication",
+    description="Most recent publication year found in the catalog",
+)
+async def get_latest_publication(session: AsyncSessionDep) -> spec.Stat:
     result = await session.execute(
         select(func.max(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",
+        "color": "blue",
+        "icon": "clock",
+    }
 
-@page.stat("Books with Summary")
+
+@page.stat(
+    "Books with Summary",
+    icon="book-check",
+    color="teal",
+    description="Number of books that include a summary",
+)
 async def get_books_with_summary(session: AsyncSessionDep) -> int:
     result = await session.execute(
         select(func.count(models.Book.id)).where(models.Book.summary.isnot(None))

{openadmin_dev-0.6.3 → openadmin_dev-0.7.4}/examples/admin/authors.py

@@ -19,13 +19,18 @@ page = AdminPage(
 )
 
 
-@page.stat("Total Authors")
+@page.stat("Total Authors", description="Total number of authors in the catalog")
 async def get_total_authors(session: AsyncSessionDep) -> spec.StatResponse:
     result = await session.execute(select(func.count(models.Author.id)))
-    return {"value": result.scalar_one(), "icon": "sun"}
+    return {"value": result.scalar_one(), "icon": "users", "color": "indigo"}
 
 
-@page.stat("Authors with Bio")
+@page.stat(
+    "Authors with Bio",
+    icon="user-check",
+    color="emerald",
+    description="Authors that have a biography on file",
+)
 async def get_authors_with_bio(session: AsyncSessionDep) -> int:
     result = await session.execute(
         select(func.count(models.Author.id)).where(models.Author.bio.isnot(None))
@@ -33,7 +38,12 @@ async def get_authors_with_bio(session: AsyncSessionDep) -> int:
     return result.scalar_one()
 
 
-@page.stat("Avg Books per Author")
+@page.stat(
+    "Avg Books per Author",
+    icon="library",
+    color="amber",
+    description="Average number of books published per author",
+)
 async def get_avg_books_per_author(session: AsyncSessionDep) -> float:
     subq = (
         select(func.count(models.Book.id).label("cnt"))

{openadmin_dev-0.6.3 → openadmin_dev-0.7.4}/examples/admin/genres.py

@@ -4,6 +4,7 @@
 
 from sqlalchemy import func, select
 
+from openadmin import spec
 from openadmin.fastapi import AdminPage
 from openadmin.fastapi.deps import PageDep
 
@@ -59,8 +60,25 @@ async def get_all_genres(session: AsyncSessionDep, pagination: PageDep):
     ]
 
 
-@page.pie_chart("Genre Distribution", description="Share of books across all genres")
-async def get_genre_distribution(session: AsyncSessionDep):
+@page.pie_chart(
+    "Genre Distribution 1",
+    description="Share of books across all genres",
+    name_key="name",
+    value_key="count",
+)
+async def get_genre_distribution_1(session: AsyncSessionDep):
+    stmt = (
+        select(models.Genre, func.count(models.BookToGenre.book_id).label("count"))
+        .join(models.BookToGenre, models.BookToGenre.genre_id == models.Genre.id)
+        .group_by(models.Genre.id)
+        .order_by(func.count(models.BookToGenre.book_id).desc())
+    )
+    result = await session.execute(stmt)
+    return [{**g, "count": count} for g, count in result.all()]
+
+
+@page.pie_chart("Genre Distribution 2", description="Share of books across all genres")
+async def get_genre_distribution_2(session: AsyncSessionDep) -> spec.PieChart:
     stmt = (
         select(models.Genre.name, func.count(models.BookToGenre.book_id).label("count"))
         .join(models.BookToGenre, models.BookToGenre.genre_id == models.Genre.id)
@@ -68,7 +86,9 @@ async def get_genre_distribution(session: AsyncSessionDep):
         .order_by(func.count(models.BookToGenre.book_id).desc())
     )
     result = await session.execute(stmt)
-    return [{"label": row.name, "value": row.count} for row in result]
+    return {
+        "data": [{"name": row.name, "value": row.count} for row in result],
+    }
 
 
 @page.bar_chart("Books per Genre", description="Absolute book count for each genre")

{openadmin_dev-0.6.3 → openadmin_dev-0.7.4}/examples/admin/health.py

@@ -9,17 +9,32 @@ page = AdminPage(
 )
 
 
-@page.stat("API Uptime (%)")
+@page.stat(
+    "API Uptime (%)",
+    icon="check-circle",
+    color="green",
+    description="Percentage of successful API requests over the last 30 days",
+)
 async def get_api_uptime() -> float:
     return 99.97
 
 
-@page.stat("Avg Response Time (ms)")
+@page.stat(
+    "Avg Response Time (ms)",
+    icon="gauge",
+    color="blue",
+    description="Average API response time across all endpoints",
+)
 async def get_avg_response_time() -> int:
     return 84
 
 
-@page.stat("Active Connections")
+@page.stat(
+    "Active Connections",
+    icon="plug",
+    color="violet",
+    description="Current number of open client connections",
+)
 async def get_active_connections() -> int:
     return 12
 

openadmin_dev-0.7.4/examples/admin/weekdays.py

@@ -0,0 +1,87 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+
+from typing import Any
+
+from openadmin import fastapi, spec
+
+WEEKDAYS: list[dict[str, Any]] = [
+    {"day": "Monday", "books": 5},
+    {"day": "Tuesday", "books": 3},
+    {"day": "Wednesday", "books": 7},
+    {"day": "Thursday", "books": 9},
+    {"day": "Friday", "books": 10},
+]
+
+page = fastapi.AdminPage(
+    "Week Days",
+    icon="calendar",
+)
+
+
+@page.pie_chart(
+    "How many books I have read 1",
+    description="Books read per weekday, week 1",
+    name_key="day",
+    value_key="books",
+    config={
+        item["day"]: {
+            "name": item["day"],
+            "color": spec.COLORS[num % len(spec.COLORS)],
+        }
+        for num, item in enumerate(WEEKDAYS)
+    },
+    color="violet",
+    icon="book-open",
+    caption="5 day streak",
+    caption_description="Reading every day this work week",
+    caption_icon="flame",
+)
+def get_books_1() -> spec.PieChart:
+    return WEEKDAYS
+
+
+@page.pie_chart(
+    "How many books I have read 2",
+    description="Books read per weekday, week 2",
+    name_key="day",
+    value_key="books",
+    caption="3 day streak",
+    caption_description="Reading every day this work week",
+    caption_icon="flame",
+)
+def get_books_2() -> spec.PieChart:
+    return {
+        "data": WEEKDAYS,
+        "color": "amber",
+        "icon": "a-arrow-up",
+        "config": {
+            item["day"]: {
+                "name": item["day"],
+                "color": spec.COLORS[num % len(spec.COLORS)],
+            }
+            for num, item in enumerate(WEEKDAYS)
+        },
+    }
+
+
+@page.pie_chart(
+    "How many books I have read 3",
+    description="Books read per weekday, all pie chart options set",
+    color="violet",
+    icon="book-open",
+    caption="5 day streak",
+    caption_description="Reading every day this work week",
+    caption_icon="flame",
+    config={
+        item["day"]: {
+            "name": item["day"],
+            "color": spec.COLORS[num % len(spec.COLORS)],
+        }
+        for num, item in enumerate(WEEKDAYS)
+    },
+)
+def get_books_3() -> spec.PieChart:
+    return [{"name": day["day"], "value": day["value"]} for day in WEEKDAYS]

{openadmin_dev-0.6.3 → openadmin_dev-0.7.4}/examples/lib/database.py

@@ -34,7 +34,7 @@ async def lifespan():
     await engine.dispose()
 
 
-@lru_cache()
+@lru_cache
 def get_async_engine() -> AsyncEngine:
     return create_async_engine(f"sqlite+aiosqlite:///{DB_PATH}")