openadmin 0.2.0__py3-none-any.whl

openadmin/fastapi/__init__.py

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from .admin_page import AdminPage
+from .admin_panel import AdminPanel
+
+__all__ = [
+    "AdminPage",
+    "AdminPanel",
+]

openadmin/fastapi/admin_page.py

@@ -0,0 +1,526 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+import re
+import uuid
+from collections.abc import Callable
+
+from fastapi import APIRouter, FastAPI
+from openadmin import spec
+
+from . import types
+from .utils import extract_params
+
+_SPECIAL_CHARS_RE = re.compile(r"[^a-zA-Z0-9\s]")
+
+
+class AdminPage:
+    def __init__(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+    ) -> None:
+        self.name = name
+        self.description = description
+        self.state: list[types.Component] = []
+        self.router = APIRouter(prefix=f"/{name.lower().replace(' ', '-')}")
+        self.key_repeat_count: dict[str, int] = {}
+
+    def get_page_spec(self, app: FastAPI) -> spec.Page:
+        components: list[spec.Component] = []
+
+        for item in self.state:
+            url = app.url_path_for(item.function_name)
+            query, body, form = (
+                extract_params(item.func) if item.func else (None, None, None)
+            )
+
+            if isinstance(item, types.Stat):
+                components.append(
+                    spec.Stat(
+                        type="stat",
+                        name=item.name,
+                        description=item.description,
+                        method=item.method,
+                        url=url,
+                        query=query,
+                    )
+                )
+            elif isinstance(item, types.Table):
+                components.append(
+                    spec.Table(
+                        type="table",
+                        name=item.name,
+                        description=item.description,
+                        method=item.method,
+                        url=url,
+                        query=query,
+                        body=body,
+                        form=form,
+                    )
+                )
+            elif isinstance(item, types.AreaChart):
+                components.append(
+                    spec.AreaChart(
+                        type="area-chart",
+                        name=item.name,
+                        description=item.description,
+                        method=item.method,
+                        url=url,
+                        query=query,
+                    )
+                )
+            elif isinstance(item, types.BarChart):
+                components.append(
+                    spec.BarChart(
+                        type="bar-chart",
+                        name=item.name,
+                        description=item.description,
+                        method=item.method,
+                        url=url,
+                        query=query,
+                    )
+                )
+            elif isinstance(item, types.LineChart):
+                components.append(
+                    spec.LineChart(
+                        type="line-chart",
+                        name=item.name,
+                        description=item.description,
+                        method=item.method,
+                        url=url,
+                        query=query,
+                    )
+                )
+            elif isinstance(item, types.PieChart):
+                components.append(
+                    spec.PieChart(
+                        type="pie-chart",
+                        name=item.name,
+                        description=item.description,
+                        method=item.method,
+                        url=url,
+                        query=query,
+                    )
+                )
+            elif isinstance(item, types.Action):
+                components.append(
+                    spec.Action(
+                        type="action",
+                        name=item.name,
+                        description=item.description,
+                        method=item.method,
+                        url=url,
+                        is_hidden=item.is_hidden,
+                        query=query,
+                        body=body,
+                        form=form,
+                    )
+                )
+            elif isinstance(item, types.Form):
+                components.append(
+                    spec.Form(
+                        type="form",
+                        name=item.name,
+                        description=item.description,
+                        method=item.method,
+                        url=url,
+                        is_hiden=item.is_hiden,
+                        query=query,
+                        body=body,
+                        form=form,
+                    )
+                )
+            elif isinstance(item, types.Markdown):
+                components.append(
+                    spec.Markdown(
+                        type="markdown",
+                        name=item.name,
+                        description=item.description,
+                        method=item.method,
+                        url=url,
+                        query=query,
+                    )
+                )
+
+        return spec.Page(
+            name=self.name,
+            description=self.description,
+            components=components,
+        )
+
+    def _wrap_user_handler(self, item: types.Component, fastapi_decorator) -> Callable:
+        def decorator(func: Callable) -> Callable:
+            item.func = func
+            return fastapi_decorator(func)
+
+        return decorator
+
+    def __get_kebab_and_unique_name(self, name: str) -> tuple[str, str]:
+        kebab_name = _SPECIAL_CHARS_RE.sub("", name).lower().replace(" ", "-")
+
+        if kebab_name in self.key_repeat_count:
+            number = self.key_repeat_count[kebab_name]
+            self.key_repeat_count[kebab_name] += 1
+            kebab_name = f"{kebab_name}-{number}"
+        else:
+            self.key_repeat_count[kebab_name] = 1
+
+        return kebab_name, f"{kebab_name}-{uuid.uuid4()}"
+
+    def table(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Table(
+            function_name=unique_name, method="get", name=name, description=description
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.get(
+                f"/table/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def stat(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Stat(
+            function_name=unique_name, method="get", name=name, description=description
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.get(
+                f"/stat/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def markdown(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Markdown(
+            function_name=unique_name,
+            method="get",
+            name=name,
+            description=description,
+        )
+        self.state.append(item)
+
+        return self._wrap_user_handler(
+            item,
+            self.router.get(
+                f"/markdown/{kebab_name}",
+                name=unique_name,
+                description=description,
+            ),
+        )
+
+    def action_post(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        is_hiden: bool = False,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Action(
+            function_name=unique_name,
+            method="post",
+            name=name,
+            description=description,
+            is_hidden=is_hiden,
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.post(
+                f"/action/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def action_get(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        is_hiden: bool = False,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Action(
+            function_name=unique_name,
+            method="get",
+            name=name,
+            description=description,
+            is_hidden=is_hiden,
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.get(
+                f"/action/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def action_put(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        is_hiden: bool = False,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Action(
+            function_name=unique_name,
+            method="put",
+            name=name,
+            description=description,
+            is_hidden=is_hiden,
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.put(
+                f"/action/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def action_patch(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        is_hiden: bool = False,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Action(
+            function_name=unique_name,
+            method="patch",
+            name=name,
+            description=description,
+            is_hidden=is_hiden,
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.patch(
+                f"/action/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def action_delete(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        is_hiden: bool = False,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Action(
+            function_name=unique_name,
+            method="delete",
+            name=name,
+            description=description,
+            is_hidden=is_hiden,
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.delete(
+                f"/action/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def form_post(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        is_hiden: bool = False,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Form(
+            function_name=unique_name,
+            method="post",
+            name=name,
+            description=description,
+            is_hiden=is_hiden,
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.post(
+                f"/form/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def form_put(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        is_hiden: bool = False,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Form(
+            function_name=unique_name,
+            method="put",
+            name=name,
+            description=description,
+            is_hiden=is_hiden,
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.put(
+                f"/form/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def form_patch(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        is_hiden: bool = False,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Form(
+            function_name=unique_name,
+            method="patch",
+            name=name,
+            description=description,
+            is_hiden=is_hiden,
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.patch(
+                f"/form/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def form_delete(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        is_hiden: bool = False,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.Form(
+            function_name=unique_name,
+            method="delete",
+            name=name,
+            description=description,
+            is_hiden=is_hiden,
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.delete(
+                f"/form/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def area_chart(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.AreaChart(
+            function_name=unique_name, method="get", name=name, description=description
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.get(
+                f"/area-chart/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def bar_chart(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.BarChart(
+            function_name=unique_name, method="get", name=name, description=description
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.get(
+                f"/bar-chart/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def line_chart(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.LineChart(
+            function_name=unique_name, method="get", name=name, description=description
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.get(
+                f"/line-chart/{kebab_name}", name=unique_name, description=description
+            ),
+        )
+
+    def pie_chart(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+    ):
+        kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
+
+        item = types.PieChart(
+            function_name=unique_name, method="get", name=name, description=description
+        )
+        self.state.append(item)
+        return self._wrap_user_handler(
+            item,
+            self.router.get(
+                f"/pie-chart/{kebab_name}", name=unique_name, description=description
+            ),
+        )

openadmin/fastapi/admin_panel.py

@@ -0,0 +1,89 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from typing import Dict, List
+
+from fastapi import FastAPI, HTTPException, status
+from openadmin import spec
+
+from . import types
+from .admin_page import AdminPage
+
+
+class AdminPanel:
+    def __init__(self, name: str, *, description: str | None = None) -> None:
+        self.version = "1.0.0"
+        self.name = name
+        self.description = description
+        self.state: List[types.Section] = []
+        self.app = FastAPI()
+        self.key_repeat_count: Dict[str, int] = {}
+        self.__init_spec_route(self.app)
+        self.root: FastAPI | None = None
+
+    def get_panel_spec(self, app: FastAPI) -> spec.Spec:
+        sections: List[spec.Section] = []
+
+        for section in self.state:
+            sections.append(
+                spec.Section(
+                    name=section.name,
+                    description=section.description,
+                    pages=[p.get_page_spec(app) for p in section.pages],
+                )
+            )
+
+        return spec.Spec(
+            version=self.version,
+            name=self.name,
+            description=self.description,
+            sections=sections,
+        )
+
+    def section(
+        self,
+        name: str,
+        *,
+        description: str | None = None,
+        pages: List[AdminPage],
+    ) -> None:
+        kebab_name = name.lower().replace(" ", "-")
+
+        if kebab_name in self.key_repeat_count:
+            number = self.key_repeat_count[kebab_name]
+            kebab_name = f"{kebab_name}-{number}"
+            self.key_repeat_count[kebab_name] += 1
+        else:
+            self.key_repeat_count[kebab_name] = 1
+
+        self.state.append(
+            types.Section(
+                name=name,
+                description=description,
+                pages=pages,
+            )
+        )
+
+        for page in pages:
+            self.app.include_router(
+                prefix=f"/{kebab_name}", router=page.router, tags=[name]
+            )
+
+    def mount_to(self, root: FastAPI) -> None:
+        self.root = root
+        root.mount("/openadmin", self.app)
+
+    def __init_spec_route(self, app: FastAPI) -> None:
+        @app.get(
+            "/spec.json",
+            response_model=spec.Spec,
+        )
+        async def _():
+            if not self.root:
+                raise HTTPException(
+                    status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+                    detail="Admin panel should be mounted to root, user admin_panel.mount_to(app)",
+                )
+
+            return self.get_panel_spec(self.root)

openadmin/fastapi/types/__init__.py

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from typing import Union
+
+from .action import Action
+from .area_chart import AreaChart
+from .bar_chart import BarChart
+from .form import Form
+from .line_chart import LineChart
+from .markdown import Markdown
+from .page_protocol import PageProtocol
+from .pie_chart import PieChart
+from .section import Section
+from .stat import Stat
+from .table import Table
+
+type Component = Union[
+    Stat, Table, AreaChart, BarChart, LineChart, PieChart, Action, Form, Markdown
+]
+
+__all__ = [
+    "PageProtocol",
+    "Section",
+    "Stat",
+    "Table",
+    "Action",
+    "AreaChart",
+    "BarChart",
+    "Form",
+    "LineChart",
+    "PieChart",
+    "Component",
+    "Markdown",
+]

openadmin/fastapi/types/action.py

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from collections.abc import Callable
+
+from pydantic import BaseModel, ConfigDict
+
+from openadmin import spec
+
+
+class Action(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    function_name: str
+    name: str
+    description: str | None
+    method: spec.HttpMethod
+    is_hidden: bool
+    func: Callable | None = None

openadmin/fastapi/types/area_chart.py

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from collections.abc import Callable
+
+from pydantic import BaseModel, ConfigDict
+
+from openadmin import spec
+
+
+class AreaChart(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    function_name: str
+    name: str
+    description: str | None
+    method: spec.HttpMethod
+    func: Callable | None = None