openadmin-dev 0.7.18__tar.gz → 0.7.20__tar.gz

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/.gitignore

@@ -12,4 +12,5 @@
 *.sqlite
 
 # Built frontend (bundled into the package at build time, see [tool.hatch.build] in pyproject.toml)
-openadmin/__client__
+openadmin/__client__
+.notes

openadmin_dev-0.7.20/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.5
+Name: openadmin-dev
+Version: 0.7.20
+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
+Author-email: Mykyta Kasianenko <mykytakasianenko@gmail.com>
+License-Expression: AGPL-3.0-or-later
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.14
+Requires-Dist: fastapi[standard]>=0.136.3
+Requires-Dist: itsdangerous>=2.2.0
+Requires-Dist: typing-extensions>=4.12.0
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img src="docs/assets/logo.png" alt="OpenAdmin" width="120" />
+
+  <h1>OpenAdmin</h1>
+
+  <p>Admin dashboards as FastAPI routes. No templates, no frontend project, no config files.</p>
+
+  <a href="https://pypi.org/project/openadmin/"><img src="https://img.shields.io/pypi/v/openadmin?style=flat-square&label=pypi&color=blue" alt="PyPI" /></a>
+  <a href="https://python.org"><img src="https://img.shields.io/badge/python-3.14%2B-blue?style=flat-square" alt="Python" /></a>
+  <a href="https://fastapi.tiangolo.com"><img src="https://img.shields.io/badge/built%20on-FastAPI-009688?style=flat-square" alt="FastAPI" /></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0--or--later-green?style=flat-square" alt="License" /></a>
+
+  <p><a href="https://openadmin-team.github.io/openadmin-py/">Documentation</a></p>
+</div>
+
+<img src="docs/assets/dashboard-screenshot.png" alt="OpenAdmin dashboard" width="100%" />
+
+---
+
+OpenAdmin is a FastAPI-native library for building admin panels. A page is a router, a widget is an endpoint — stats, tables, forms, actions, and charts, defined with typed decorators in plain Python.
+
+```python
+from openadmin import spec
+from openadmin.fastapi import AdminPage, AdminPanel
+
+page = AdminPage("Dashboard", icon="layout-dashboard")
+
+
+@page.stat("Total Users")
+async def total_users() -> spec.Stat:
+    return 1_024
+
+
+@page.table("Recent Users")
+async def recent_users() -> spec.Table:
+    return {
+        "data": [
+            {"id": 1, "name": "Alice", "role": "admin"},
+            {"id": 2, "name": "Bob", "role": "viewer"},
+        ]
+    }
+
+
+admin = AdminPanel("My Admin")
+admin.section("General", pages=[page])
+```
+
+```python
+from fastapi import FastAPI
+
+app = FastAPI()
+app.mount("/admin", admin.app)
+```
+
+Each decorated function is a normal FastAPI handler — dependency injection, `Query`/`Body` parameters, and OpenAPI docs all work as they would on any route.
+
+## Installation
+
+```bash
+pip install openadmin
+# or
+uv add openadmin
+```
+
+## Documentation
+
+Everything else — the full component reference, authentication, and worked cookbook recipes — lives at:
+
+**[openadmin-team.github.io/openadmin-py](https://openadmin-team.github.io/openadmin-py/)**
+
+- [Getting Started](https://openadmin-team.github.io/openadmin-py/introduction/getting-started) — build a minimal panel end to end
+- [Components](https://openadmin-team.github.io/openadmin-py/components/) — stats, tables, forms, actions, and charts
+- [Authentication](https://openadmin-team.github.io/openadmin-py/auth/) — gate the panel behind a login screen
+- [Cookbook](https://openadmin-team.github.io/openadmin-py/cookbook/implementing-auth) — recipes for row actions, reference fields, and auth
+
+## Development
+
+```bash
+# Run the example app
+make dev/example
+
+# Run all checks (format, lint, types, tests, security)
+make check
+
+# Auto-fix formatting and lint issues
+make fix
+```
+
+## License
+
+[AGPL-3.0-or-later](LICENSE) — © 2026 OpenAdmin

openadmin_dev-0.7.20/README.md

@@ -0,0 +1,91 @@
+<div align="center">
+  <img src="docs/assets/logo.png" alt="OpenAdmin" width="120" />
+
+  <h1>OpenAdmin</h1>
+
+  <p>Admin dashboards as FastAPI routes. No templates, no frontend project, no config files.</p>
+
+  <a href="https://pypi.org/project/openadmin/"><img src="https://img.shields.io/pypi/v/openadmin?style=flat-square&label=pypi&color=blue" alt="PyPI" /></a>
+  <a href="https://python.org"><img src="https://img.shields.io/badge/python-3.14%2B-blue?style=flat-square" alt="Python" /></a>
+  <a href="https://fastapi.tiangolo.com"><img src="https://img.shields.io/badge/built%20on-FastAPI-009688?style=flat-square" alt="FastAPI" /></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0--or--later-green?style=flat-square" alt="License" /></a>
+
+  <p><a href="https://openadmin-team.github.io/openadmin-py/">Documentation</a></p>
+</div>
+
+<img src="docs/assets/dashboard-screenshot.png" alt="OpenAdmin dashboard" width="100%" />
+
+---
+
+OpenAdmin is a FastAPI-native library for building admin panels. A page is a router, a widget is an endpoint — stats, tables, forms, actions, and charts, defined with typed decorators in plain Python.
+
+```python
+from openadmin import spec
+from openadmin.fastapi import AdminPage, AdminPanel
+
+page = AdminPage("Dashboard", icon="layout-dashboard")
+
+
+@page.stat("Total Users")
+async def total_users() -> spec.Stat:
+    return 1_024
+
+
+@page.table("Recent Users")
+async def recent_users() -> spec.Table:
+    return {
+        "data": [
+            {"id": 1, "name": "Alice", "role": "admin"},
+            {"id": 2, "name": "Bob", "role": "viewer"},
+        ]
+    }
+
+
+admin = AdminPanel("My Admin")
+admin.section("General", pages=[page])
+```
+
+```python
+from fastapi import FastAPI
+
+app = FastAPI()
+app.mount("/admin", admin.app)
+```
+
+Each decorated function is a normal FastAPI handler — dependency injection, `Query`/`Body` parameters, and OpenAPI docs all work as they would on any route.
+
+## Installation
+
+```bash
+pip install openadmin
+# or
+uv add openadmin
+```
+
+## Documentation
+
+Everything else — the full component reference, authentication, and worked cookbook recipes — lives at:
+
+**[openadmin-team.github.io/openadmin-py](https://openadmin-team.github.io/openadmin-py/)**
+
+- [Getting Started](https://openadmin-team.github.io/openadmin-py/introduction/getting-started) — build a minimal panel end to end
+- [Components](https://openadmin-team.github.io/openadmin-py/components/) — stats, tables, forms, actions, and charts
+- [Authentication](https://openadmin-team.github.io/openadmin-py/auth/) — gate the panel behind a login screen
+- [Cookbook](https://openadmin-team.github.io/openadmin-py/cookbook/implementing-auth) — recipes for row actions, reference fields, and auth
+
+## Development
+
+```bash
+# Run the example app
+make dev/example
+
+# Run all checks (format, lint, types, tests, security)
+make check
+
+# Auto-fix formatting and lint issues
+make fix
+```
+
+## License
+
+[AGPL-3.0-or-later](LICENSE) — © 2026 OpenAdmin

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/docs/content/index.md

@@ -5,7 +5,7 @@ layout: home
 hero:
   name: "OpenAdmin"
   text: "Admin panel for python"
-  tagline: Build admin dashboards as FastAPI routes — stats, tables, charts, and actions, all in pure Python.
+  tagline: Build admin dashboards as FastAPI routes — stats, tables, charts, and actions, all in pure Python using any orm and api.
   actions:
     - theme: brand
       text: What is OpenAdmin?

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/docs/content/introduction/getting-started.md

@@ -10,13 +10,13 @@ This walks through building a minimal admin panel from scratch: one page, one st
 ## Installation
 
 ```bash
-pip install openadmin-py
+pip install openadmin
 ```
 
 or with `uv`:
 
 ```bash
-uv add openadmin-py
+uv add openadmin
 ```
 
 ## Build a page

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/examples/admin/authors.py

@@ -160,7 +160,6 @@ class AddAuthorBody(BaseModel):
     first_name: str
     last_name: str
     bio: str | None = None
-    friend: int
 
 
 @page.form(
@@ -181,7 +180,4 @@ async def add_author(body: AddAuthorBody, session: AsyncSessionDep) -> spec.Form
     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},
-    }
+    return {"toast": f"Added author '{name}'"}

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/examples/admin/books.py

@@ -5,12 +5,12 @@
 import asyncio
 from urllib.parse import quote
 
-from fastapi import Query
+from fastapi import Query, UploadFile
 from pydantic import BaseModel
 from sqlalchemy import func, select
 
 from openadmin import spec
-from openadmin.fastapi import AdminPage
+from openadmin.fastapi import AdminPage, reference_action
 from openadmin.fastapi.deps import PageDep, SearchDep
 
 from ..lib import models
@@ -44,6 +44,14 @@ async def get_books_without_publisher(session: AsyncSessionDep) -> int:
 BOOK_COVER_URL = "https://img.magnific.com/free-photo/beautiful-tropical-beach-sea-ocean-with-white-cloud-blue-sky-copyspace_74190-8663.jpg?semt=ais_hybrid&w=740&q=80"
 
 
+@page.action(
+    "Upload cover",
+    is_hidden=True,
+)
+async def upload_cover(id: int, cover: UploadFile) -> spec.Action:
+    return f"File uploaded {cover.filename} {id=}"
+
+
 @page.table(
     "All Books",
     description="Browse all books with search and pagination",
@@ -112,6 +120,9 @@ async def get_all_books(
                     "reference": {"label": "Link to the book"},
                     "attachment": {"label": "Book in pdf"},
                 },
+                "__actions__": [
+                    {"action": reference_action(upload_cover), "form": {"id": book.id}}
+                ],
             }
             for book, author in result.all()
         ],
@@ -161,10 +172,7 @@ async def add_book(body: AddBookBody, session: AsyncSessionDep) -> spec.Form:
     session.add(book)
     await session.commit()
     await session.refresh(book)
-    return {
-        "message": f"Added book '{book.title}'",
-        "table": {"id": book.id, "title": book.title},
-    }
+    return {"toast": f"Added book '{book.title}'"}
 
 
 @page.action("Delete Book", method="delete", description="Remove a book by ID")
@@ -177,9 +185,4 @@ async def delete_book(
         await session.delete(book)
         await session.commit()
     found = book is not None
-    return {
-        "message": f"Deleted book #{book_id}"
-        if found
-        else f"Book #{book_id} not found",
-        "table": {"deleted": book_id, "found": found},
-    }
+    return f"Deleted book #{book_id}" if found else f"Book #{book_id} not found"

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/examples/admin/control_panel.py

@@ -48,10 +48,8 @@ async def ping_service(
     target: str = Query("api", description="Service name to ping"),
 ) -> spec.Action:
     return {
-        "icon": "activity",
-        "color": "green",
-        "toast": f"{target} responded in 12ms",
-        "message": f"Pinged '{target}' — reachable (example response, nothing was contacted)",
+        "toast": f"Pinged '{target}' — reachable in 12ms "
+        "(example response, nothing was contacted)"
     }
 
 
@@ -93,11 +91,7 @@ async def update_feature_flag(
     flag_name: str = Query(..., description="Flag key, e.g. new-dashboard"),
     enabled: bool = Query(..., description="New flag state"),
 ) -> spec.Action:
-    return {
-        "toast": f"{flag_name} -> {enabled}",
-        "message": "Preview of the change below (example data, flag was not modified)",
-        "table": [{"flag": flag_name, "previous": not enabled, "new": enabled}],
-    }
+    return {"toast": f"{flag_name} -> {enabled} (example only, flag was not modified)"}
 
 
 @page.action(
@@ -124,12 +118,10 @@ async def rotate_api_key(
 async def purge_temp_files(
     older_than_days: int = Query(7, ge=0, description="Age threshold in days"),
 ) -> spec.Action:
-    return {
-        "message": (
-            f"Would delete files older than {older_than_days} days "
-            "(example — nothing was purged)"
-        )
-    }
+    return (
+        f"Would delete files older than {older_than_days} days "
+        "(example — nothing was purged)"
+    )
 
 
 # ---------------------------------------------------------------------------
@@ -447,17 +439,7 @@ class WebhookBody(BaseModel):
     color="teal",
 )
 async def create_webhook(body: WebhookBody) -> spec.Form:
-    return {
-        "icon": "webhook",
-        "color": "teal",
-        "toast": "Webhook created",
-        "message": f"Would create a webhook for '{body.event}' -> {body.url}",
-        "table": {
-            "data": [{"id": 1, "url": body.url, "event": body.event}],
-            "icon": "webhook",
-            "color": "teal",
-        },
-    }
+    return {"toast": f"Would create a webhook for '{body.event}' -> {body.url}"}
 
 
 class RateLimitBody(BaseModel):
@@ -475,8 +457,6 @@ class RateLimitBody(BaseModel):
 )
 async def update_rate_limit(body: RateLimitBody) -> spec.Form:
     return {
-        "icon": "gauge",
-        "color": "cyan",
         "toast": f"Rate limit set to {body.requests_per_minute}/min "
         f"(burst {body.burst_size}) — example only, nothing was saved",
     }
@@ -509,6 +489,15 @@ async def rename_environment(
 )
 async def schedule_config_reset(
     config_id: int = Query(..., description="Config entry to reset"),
+    environment: str = Query("production", description="Environment to target"),
+    reason: str = Query(..., description="Why the reset is needed"),
+    scheduled_by: str = Query(..., description="Who is requesting the reset"),
+    maintenance_window: str = Query(
+        ..., description="Maintenance window label, e.g. Sat 02:00 UTC"
+    ),
+    notify_owner: bool = Query(True, description="Notify the config owner beforehand"),
+    dry_run: bool = Query(False, description="Preview the reset without scheduling it"),
+    retry_count: int = Query(0, description="Number of retries if the reset fails"),
 ) -> spec.Form:
     return None
 

openadmin_dev-0.7.20/examples/admin/form_test.py

@@ -0,0 +1,73 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from datetime import date, datetime
+from enum import Enum, StrEnum
+from typing import Literal
+
+from fastapi import UploadFile
+
+from openadmin import spec
+from openadmin.fastapi import AdminPage
+
+page = AdminPage("Test forms", icon="test-tube")
+
+
+class Methods(Enum):
+    GET = "GET"
+    POST = "POST"
+
+
+class MethodsStr(StrEnum):
+    GET = "GET"
+    POST = "POST"
+
+
+@page.form(
+    "Test all fields",
+    method="post",
+    icon="university",
+    color="green",
+    fields={
+        "string": {"icon": "type", "color": "blue"},
+        "int": {"icon": "hash", "color": "indigo"},
+        "float": {"icon": "binary", "color": "violet"},
+        "date": {"icon": "calendar-days", "color": "purple"},
+        "dates": {"icon": "calendar", "color": "fuchsia"},
+        "bool": {"icon": "toggle-left", "color": "pink"},
+        "list_of_strings": {"icon": "list", "color": "rose"},
+        "list_of_ints": {"icon": "list-ordered", "color": "red"},
+        "file": {"icon": "file-up", "color": "orange"},
+        "files": {"icon": "files", "color": "amber"},
+        "rich_text": {"icon": "pilcrow", "color": "yellow", "style": "rich-text"},
+        "literals": {"icon": "list-filter", "color": "lime"},
+        "enum": {"icon": "tag", "color": "green"},
+        "str_enum": {"icon": "tags", "color": "emerald"},
+        "list_literals": {"icon": "list-checks", "color": "teal"},
+        "list_enum": {"icon": "layers", "color": "cyan"},
+        "list_str_enum": {"icon": "list-tree", "color": "sky"},
+    },
+)
+def get_info(
+    string: str,
+    int: int,
+    float: float,
+    date: list[datetime],
+    dates: list[date],
+    bool: bool,
+    list_of_strings: list[str],
+    list_of_ints: list[int],
+    file: UploadFile,
+    files: list[UploadFile],
+    rich_text: str,
+    literals: Literal["get", "post"],
+    enum: Methods,
+    str_enum: MethodsStr,
+    list_literals: list[Literal["get", "post"]],
+    list_enum: list[Methods],
+    list_str_enum: list[MethodsStr],
+) -> spec.Form:
+    return {
+        "toast": f"All good ! {rich_text=} {list_literals=} {list_str_enum=} {list_enum=} {enum=} {literals=} {str_enum} {string=} {int=} {float=} {date=} {dates=} {bool=} {list_of_ints=} {list_of_strings=} {file.filename=} {len(files)=}"
+    }

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/examples/admin/health.py

@@ -5,7 +5,10 @@
 from openadmin.fastapi import AdminPage
 
 page = AdminPage(
-    "Health", icon="heart-pulse", description="System health and infrastructure metrics"
+    "Health",
+    icon="heart-pulse",
+    description="System health and infrastructure metrics",
+    color="blue",
 )
 
 

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/examples/admin/overview.py

@@ -86,7 +86,7 @@ Foreign keys are enforced at the application layer.
 )
 async def ping_database(session: AsyncSessionDep) -> spec.Action:
     await session.execute(text("SELECT 1"))
-    return {"message": "Database is reachable"}
+    return {"toast": "Database is reachable"}
 
 
 async def _all_table_counts(session: AsyncSessionDep) -> list[tuple[str, int]]:

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/examples/admin/publishers.py

@@ -99,7 +99,4 @@ async def add_publisher(body: AddPublisherBody, session: AsyncSessionDep) -> spe
     session.add(publisher)
     await session.commit()
     await session.refresh(publisher)
-    return {
-        "message": f"Added publisher '{publisher.name}'",
-        "table": {"id": publisher.id, "name": publisher.name},
-    }
+    return {"toast": f"Added publisher '{publisher.name}'"}

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/examples/admin/tags.py

@@ -12,7 +12,9 @@ from openadmin.fastapi.deps import PageDep
 from ..lib import models
 from ..lib.database import AsyncSessionDep
 
-page = AdminPage("Tags", icon="tag", description="Manage and analyze book tags")
+page = AdminPage(
+    "Tags", icon="tag", description="Manage and analyze book tags", color="red"
+)
 
 
 @page.stat("Total Tags")
@@ -97,9 +99,8 @@ async def remove_tag_from_book(
         await session.delete(link)
         await session.commit()
     removed = link is not None
-    return {
-        "message": f"Removed tag #{tag_id} from book #{book_id}"
+    return (
+        f"Removed tag #{tag_id} from book #{book_id}"
         if removed
-        else f"No such tag assignment (book #{book_id}, tag #{tag_id})",
-        "table": {"book_id": book_id, "tag_id": tag_id, "removed": removed},
-    }
+        else f"No such tag assignment (book #{book_id}, tag #{tag_id})"
+    )

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/examples/admin/weekdays.py

@@ -15,10 +15,7 @@ WEEKDAYS: list[dict[str, Any]] = [
     {"day": "Friday", "books": 10, "coffe": 9},
 ]
 
-page = fastapi.AdminPage(
-    "Week Days",
-    icon="calendar",
-)
+page = fastapi.AdminPage("Week Days", icon="calendar", color="green")
 
 
 @page.pie_chart(

{openadmin_dev-0.7.18 → openadmin_dev-0.7.20}/examples/main.py

@@ -15,6 +15,7 @@ from .admin import (
     books,
     control_panel,
     docs,
+    form_test,
     genres,
     health,
     overview,
@@ -62,6 +63,8 @@ admin_panel.section(
     icon="server",
     pages=[health.page, reports.page, overview.page, control_panel.page],
 )
-admin_panel.section("Weekdays", icon="calendar-days", pages=[weekdays.page])
+admin_panel.section(
+    "Weekdays", icon="calendar-days", pages=[weekdays.page, form_test.page]
+)
 
 app.mount("/admin", admin_panel.app, name="admin_panel")

openadmin_dev-0.7.20/openadmin/__client__/assets/CardTitle-g-eR1YB7.js

@@ -0,0 +1 @@
+import{On as e,Zn as t,b as n,k as r,mt as i,xt as a}from"./runtime-core.esm-bundler-B4b-2GOK.js";import{Wc as o}from"./error-C_Ap5sRv.js";var s=r({__name:`Card`,props:{class:{type:[Boolean,null,String,Object,Array]}},setup(r){let s=r;return(r,c)=>(i(),n(`div`,{"data-slot":`card`,class:t(e(o)(`bg-card text-card-foreground flex flex-col gap-6 rounded-lg border py-6`,s.class))},[a(r.$slots,`default`)],2))}}),c=r({__name:`CardDescription`,props:{class:{type:[Boolean,null,String,Object,Array]}},setup(r){let s=r;return(r,c)=>(i(),n(`p`,{"data-slot":`card-description`,class:t(e(o)(`text-muted-foreground text-sm`,s.class))},[a(r.$slots,`default`)],2))}}),l=r({__name:`CardHeader`,props:{class:{type:[Boolean,null,String,Object,Array]}},setup(r){let s=r;return(r,c)=>(i(),n(`div`,{"data-slot":`card-header`,class:t(e(o)(`@container/card-header grid auto-rows-min grid-rows-[auto_auto] items-start gap-1.5 px-6 has-data-[slot=card-action]:grid-cols-[1fr_auto] [.border-b]:pb-6`,s.class))},[a(r.$slots,`default`)],2))}}),u=r({__name:`CardTitle`,props:{class:{type:[Boolean,null,String,Object,Array]}},setup(r){let s=r;return(r,c)=>(i(),n(`h3`,{"data-slot":`card-title`,class:t(e(o)(`leading-none font-semibold`,s.class))},[a(r.$slots,`default`)],2))}});export{s as i,l as n,c as r,u as t};