openadmin 0.3.1__tar.gz → 0.7.12__tar.gz

{openadmin-0.3.1 → openadmin-0.7.12}/.github/actions/format/action.yml

@@ -6,5 +6,8 @@ runs:
     - uses: astral-sh/setup-uv@v4
       with:
         enable-cache: true
+    - uses: oven-sh/setup-bun@v2
+    - shell: bash
+      run: cd client && bun install --frozen-lockfile
     - shell: bash
       run: make check/format

{openadmin-0.3.1 → openadmin-0.7.12}/.github/actions/lint/action.yml

@@ -6,5 +6,8 @@ runs:
     - uses: astral-sh/setup-uv@v4
       with:
         enable-cache: true
+    - uses: oven-sh/setup-bun@v2
+    - shell: bash
+      run: cd client && bun install --frozen-lockfile
     - shell: bash
       run: make check/lint

{openadmin-0.3.1 → openadmin-0.7.12}/.github/workflows/publish.yml

@@ -25,6 +25,9 @@ jobs:
       - uses: astral-sh/setup-uv@v4
         with:
           enable-cache: true
+      - uses: oven-sh/setup-bun@v2
+      - name: Build frontend
+        run: cd client && bun install --frozen-lockfile && bun run build
       - name: Override package name for dev
         if: github.ref_name == 'dev'
         run: sed -i 's/^name = "openadmin"$/name = "openadmin-dev"/' pyproject.toml

openadmin-0.7.12/.gitignore

@@ -0,0 +1,15 @@
+# IDE
+.vscode
+
+# Python
+.pytest_cache
+.ruff_cache
+.venv
+**/__pycache__
+
+# DB
+*.db
+*.sqlite
+
+# Built frontend (bundled into the package at build time, see [tool.hatch.build] in pyproject.toml)
+openadmin/__client__

openadmin-0.7.12/Makefile

@@ -0,0 +1,51 @@
+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/
+	@ uv run reuse annotate --license AGPL-3.0-or-later --copyright "OpenAdmin" --recursive --skip-unrecognised $$(find client/src -mindepth 1 -maxdepth 1 ! -name assets)
+
+fix/format:
+	@ cd client && bun run fix:format
+	@ uv run ruff format .
+
+fix/lint:
+	@ cd client && bun run fix:lint
+	@ uv run ruff check --fix .
+
+fix: fix/license fix/format fix/lint
+
+check/format:
+	@ cd client && bun run check:format
+	@ uv run ruff format --check .
+
+check/lint:
+	@ cd client && bun run 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:
+	@ cd client && bun run build
+	@ PYTHONPATH=. uv run fastapi dev examples/main.py --host 0.0.0.0 --port $${PORT:-8000} --reload

{openadmin-0.3.1 → openadmin-0.7.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openadmin
-Version: 0.3.1
+Version: 0.7.12
 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
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.14
 Requires-Dist: fastapi[standard]>=0.136.3
+Requires-Dist: typing-extensions>=4.12.0
 Description-Content-Type: text/markdown
 
 <!-- <div align="center">
@@ -60,16 +61,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 +93,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 +107,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 +125,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 +151,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 +162,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 +193,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 +226,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-0.3.1 → openadmin-0.7.12}/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-0.3.1 → openadmin-0.7.12}/REUSE.toml

@@ -12,6 +12,7 @@ path = [
     "LICENSE",
     "**/__pycache__",
     "docs/**",
+    "client/**",
 ]
 SPDX-FileCopyrightText = "OpenAdmin"
 SPDX-License-Identifier = "AGPL-3.0-or-later"

openadmin-0.7.12/examples/admin/analytics.py

@@ -0,0 +1,96 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from sqlalchemy import func, select
+
+from openadmin import spec
+from openadmin.fastapi import AdminPage
+
+from ..lib import models
+from ..lib.database import AsyncSessionDep
+
+page = AdminPage(
+    "Analytics",
+    icon="bar-chart",
+    description="Library-wide publication trends and insights",
+)
+
+
+@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()
+
+
+@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 {
+        "value": result.scalar_one_or_none() or "N/A",
+        "color": "blue",
+        "icon": "clock",
+    }
+
+
+@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))
+    )
+    return result.scalar_one()
+
+
+@page.markdown("Library Overview")
+async def get_library_overview(session: AsyncSessionDep) -> str:
+    total_books = (
+        await session.execute(select(func.count(models.Book.id)))
+    ).scalar_one()
+    total_authors = (
+        await session.execute(select(func.count(models.Author.id)))
+    ).scalar_one()
+    total_publishers = (
+        await session.execute(select(func.count(models.Publisher.id)))
+    ).scalar_one()
+    total_genres = (
+        await session.execute(select(func.count(models.Genre.id)))
+    ).scalar_one()
+    total_tags = (await session.execute(select(func.count(models.Tag.id)))).scalar_one()
+
+    return f"""# Library Overview
+
+This catalog contains **{total_books:,} books** written by **{total_authors} authors**
+and published by **{total_publishers} publishers**.
+
+## Classification
+
+The collection is organized across **{total_genres} genres** and annotated with **{total_tags} tags**,
+enabling precise discovery and filtering across the full catalog.
+
+## Coverage
+
+Books span multiple centuries of publication history, from early historical works through
+contemporary releases, with particular depth in the 20th and 21st century catalog.
+"""

openadmin-0.7.12/examples/admin/authors.py

@@ -0,0 +1,138 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+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
+
+from ..lib import models
+from ..lib.database import AsyncSessionDep
+
+page = AdminPage(
+    "Authors",
+    icon="users",
+    description="Manage book authors and view productivity stats",
+)
+
+
+@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": "users", "color": "indigo"}
+
+
+@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):
+    result = await session.execute(
+        select(func.count(models.Author.id)).where(models.Author.bio.isnot(None))
+    )
+    return result.scalar_one()
+
+
+@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"))
+        .group_by(models.Book.author_id)
+        .subquery()
+    )
+    result = await session.execute(select(func.avg(subq.c.cnt)))
+    return round(float(result.scalar_one() or 0), 2)
+
+
+@page.table(
+    "All Authors",
+    description="Browse authors with search and book counts",
+    icon="user-pen",
+    color="indigo",
+)
+async def get_all_authors(
+    session: AsyncSessionDep, pagination: PageDep, search: SearchQueryDep
+) -> spec.Table:
+    stmt = (
+        select(models.Author, func.count(models.Book.id).label("book_count"))
+        .outerjoin(models.Book, models.Book.author_id == models.Author.id)
+        .group_by(models.Author.id)
+        .offset((pagination.page - 1) * pagination.per_page)
+        .limit(pagination.per_page)
+    )
+    if search:
+        full_name = models.Author.first_name + " " + models.Author.last_name
+        stmt = stmt.where(full_name.ilike(f"%{search}%"))
+    result = await session.execute(stmt)
+    return [
+        {
+            "id": author.id,
+            "name": f"{author.first_name} {author.last_name}",
+            "bio": (author.bio[:80] + "...")
+            if author.bio and len(author.bio) > 80
+            else author.bio,
+            "book_count": count,
+            "__view__": f"{author.first_name} {author.last_name}",
+        }
+        for author, count in result.all()
+    ]
+
+
+@page.bar_chart(
+    "Top Authors by Book Count",
+    description="The 10 most prolific authors in the catalog",
+)
+async def get_top_authors(session: AsyncSessionDep):
+    stmt = (
+        select(
+            (models.Author.first_name + " " + models.Author.last_name).label("name"),
+            func.count(models.Book.id).label("count"),
+        )
+        .join(models.Book, models.Book.author_id == models.Author.id)
+        .group_by(models.Author.id)
+        .order_by(func.count(models.Book.id).desc())
+        .limit(10)
+    )
+    result = await session.execute(stmt)
+    return [{"label": row.name, "value": row.count} for row in result]
+
+
+class AddAuthorBody(BaseModel):
+    first_name: str
+    last_name: str
+    bio: str | None = None
+    friend: int
+
+
+@page.form(
+    "Add Author",
+    description="Register a new author in the catalog",
+    fields={
+        "friend": {
+            "reference": get_all_authors,
+            "icon": "user",
+            "color": "blue",
+            "reference_field": "id",
+        }
+    },
+)
+async def add_author(body: AddAuthorBody, session: AsyncSessionDep) -> spec.Form:
+    author = models.Author(**body.model_dump())
+    session.add(author)
+    await session.commit()
+    await session.refresh(author)
+    name = f"{author.first_name} {author.last_name}"
+    return {
+        "message": f"Added author '{name}'",
+        "table": {"id": author.id, "name": name},
+    }