openadmin-dev 0.7.5__tar.gz → 0.7.8__tar.gz

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openadmin-dev
-Version: 0.7.5
+Version: 0.7.8
 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.7.8/examples/admin/docs.py

@@ -0,0 +1,39 @@
+# SPDX-FileCopyrightText: 2026 OpenAdmin
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from openadmin import fastapi, spec
+
+page = fastapi.AdminPage("Docs", icon="dock")
+
+
+@page.markdown("Company policy 1", icon="podcast", color="blue")
+def company_policy_1() -> spec.Markdown:
+    return """
+# Hello World
+
+This is new text
+
+---
+
+- Cake
+- Limonade
+"""
+
+
+@page.markdown("Company policy 2")
+def company_policy_2() -> spec.Markdown:
+    return {
+        "content": """
+                    # Hello World
+
+                    This is new text
+
+                    ---
+
+                    - Cake
+                    - Limonade
+        """,
+        "color": "yellow",
+        "icon": "a-arrow-up",
+    }

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/examples/main.py

@@ -11,6 +11,7 @@ from .admin import (
     analytics,
     authors,
     books,
+    docs,
     genres,
     health,
     overview,
@@ -35,6 +36,14 @@ admin_panel = AdminPanel(
     "Book Library Admin", description="Manage and explore the book catalog"
 )
 
+admin_panel.section(
+    "Docs",
+    icon="download-cloud",
+    pages=[
+        docs.page,
+    ],
+)
+
 admin_panel.section(
     "Library", icon="library", pages=[books.page, authors.page, publishers.page]
 )

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/openadmin/fastapi/action.py

@@ -16,4 +16,6 @@ class Action:
     description: str | None
     method: spec.HttpMethod
     is_hidden: bool
+    color: spec.Color | None
+    icon: spec.Icon | None
     func: Callable | None = field(default=None)

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/openadmin/fastapi/admin_page.py

@@ -155,6 +155,8 @@ class AdminPage:
                         method=item.method,
                         url=url,
                         is_hidden=item.is_hidden,
+                        icon=item.icon,
+                        color=item.color,
                         query=query,
                         body=body,
                         form=form,
@@ -170,6 +172,8 @@ class AdminPage:
                         method=item.method,
                         url=url,
                         is_hidden=item.is_hidden,
+                        icon=item.icon,
+                        color=item.color,
                         query=query,
                         body=body,
                         form=form,
@@ -177,10 +181,12 @@ class AdminPage:
                 )
             elif isinstance(item, Markdown):
                 components.append(
-                    spec.Markdown(
+                    spec.MarkdownComponent(
                         type="markdown",
                         id=item.id,
                         name=item.name,
+                        icon=item.icon,
+                        color=item.color,
                         description=item.description,
                         method=item.method,
                         url=url,
@@ -276,6 +282,8 @@ class AdminPage:
         name: str,
         *,
         description: str | None = None,
+        color: spec.Color | None = None,
+        icon: spec.Icon | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -285,6 +293,8 @@ class AdminPage:
             name=name,
             description=description,
             id=kebab_name,
+            icon=icon,
+            color=color,
         )
         self.state.append(item)
 
@@ -303,6 +313,8 @@ class AdminPage:
         *,
         description: str | None = None,
         is_hidden: bool = False,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -312,6 +324,8 @@ class AdminPage:
             name=name,
             description=description,
             is_hidden=is_hidden,
+            icon=icon,
+            color=color,
             id=kebab_name,
         )
         self.state.append(item)
@@ -328,6 +342,8 @@ class AdminPage:
         *,
         description: str | None = None,
         is_hidden: bool = False,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -337,6 +353,8 @@ class AdminPage:
             name=name,
             description=description,
             is_hidden=is_hidden,
+            icon=icon,
+            color=color,
             id=kebab_name,
         )
         self.state.append(item)
@@ -353,6 +371,8 @@ class AdminPage:
         *,
         description: str | None = None,
         is_hidden: bool = False,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -362,6 +382,8 @@ class AdminPage:
             name=name,
             description=description,
             is_hidden=is_hidden,
+            icon=icon,
+            color=color,
             id=kebab_name,
         )
         self.state.append(item)
@@ -378,6 +400,8 @@ class AdminPage:
         *,
         description: str | None = None,
         is_hidden: bool = False,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -387,6 +411,8 @@ class AdminPage:
             name=name,
             description=description,
             is_hidden=is_hidden,
+            icon=icon,
+            color=color,
             id=kebab_name,
         )
         self.state.append(item)
@@ -403,6 +429,8 @@ class AdminPage:
         *,
         description: str | None = None,
         is_hidden: bool = False,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -412,6 +440,8 @@ class AdminPage:
             name=name,
             description=description,
             is_hidden=is_hidden,
+            icon=icon,
+            color=color,
             id=kebab_name,
         )
         self.state.append(item)
@@ -428,6 +458,8 @@ class AdminPage:
         *,
         description: str | None = None,
         is_hidden: bool = False,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -437,6 +469,8 @@ class AdminPage:
             name=name,
             description=description,
             is_hidden=is_hidden,
+            icon=icon,
+            color=color,
             id=kebab_name,
         )
         self.state.append(item)
@@ -453,6 +487,8 @@ class AdminPage:
         *,
         description: str | None = None,
         is_hidden: bool = False,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -462,6 +498,8 @@ class AdminPage:
             name=name,
             description=description,
             is_hidden=is_hidden,
+            icon=icon,
+            color=color,
             id=kebab_name,
         )
         self.state.append(item)
@@ -478,6 +516,8 @@ class AdminPage:
         *,
         description: str | None = None,
         is_hidden: bool = False,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -487,6 +527,8 @@ class AdminPage:
             name=name,
             description=description,
             is_hidden=is_hidden,
+            icon=icon,
+            color=color,
             id=kebab_name,
         )
         self.state.append(item)
@@ -503,6 +545,8 @@ class AdminPage:
         *,
         description: str | None = None,
         is_hidden: bool = False,
+        icon: spec.Icon | None = None,
+        color: spec.Color | None = None,
     ):
         kebab_name, unique_name = self.__get_kebab_and_unique_name(name)
 
@@ -512,6 +556,8 @@ class AdminPage:
             name=name,
             description=description,
             is_hidden=is_hidden,
+            icon=icon,
+            color=color,
             id=kebab_name,
         )
         self.state.append(item)

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/openadmin/fastapi/form.py

@@ -16,4 +16,6 @@ class Form:
     description: str | None
     method: spec.HttpMethod
     is_hidden: bool
+    color: spec.Color | None
+    icon: spec.Icon | None
     func: Callable | None = field(default=None)

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/openadmin/fastapi/markdown.py

@@ -14,5 +14,7 @@ class Markdown:
     id: str
     name: str
     description: str | None
+    icon: spec.Icon | None
+    color: spec.Color | None
     method: spec.HttpMethod
     func: Callable | None = field(default=None)

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/openadmin/spec/__init__.py

@@ -17,7 +17,7 @@ from .form import Form
 from .http_methods import HttpMethod
 from .icons import Icon
 from .line_chart import LineChart
-from .markdown import Markdown
+from .markdown import Markdown, MarkdownComponent, MarkdownContent, MarkdownResponse
 from .page import Page
 from .pie_chart import (
     PieChart,
@@ -49,6 +49,9 @@ __all__ = [
     "Icon",
     "LineChart",
     "Markdown",
+    "MarkdownComponent",
+    "MarkdownContent",
+    "MarkdownResponse",
     "Page",
     "PieChart",
     "PieChartComponent",

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/openadmin/spec/action.py

@@ -6,7 +6,9 @@ from typing import Literal
 
 from pydantic import BaseModel, Field
 
+from .colors import Color
 from .http_methods import HttpMethod
+from .icons import Icon
 from .property import Property
 
 
@@ -16,6 +18,8 @@ class Action(BaseModel):
     name: str
     description: str | None
     url: str
+    icon: Icon | None
+    color: Color | None
     method: HttpMethod
     is_hidden: bool
     form: list[Property] | None = Field(None)

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/openadmin/spec/component.py

@@ -8,7 +8,7 @@ from .area_chart import AreaChart
 from .bar_chart import BarChartComponent
 from .form import Form
 from .line_chart import LineChart
-from .markdown import Markdown
+from .markdown import MarkdownComponent
 from .pie_chart import PieChartComponent
 from .stat import StatComponent
 from .table import TableComponent
@@ -22,5 +22,5 @@ type Component = (
     | PieChartComponent
     | Action
     | Form
-    | Markdown
+    | MarkdownComponent
 )

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/openadmin/spec/form.py

@@ -6,7 +6,9 @@ from typing import Literal
 
 from pydantic import BaseModel, Field
 
+from .colors import Color
 from .http_methods import HttpMethod
+from .icons import Icon
 from .property import Property
 
 
@@ -16,6 +18,8 @@ class Form(BaseModel):
     name: str
     description: str | None
     url: str
+    icon: Icon | None
+    color: Color | None
     method: HttpMethod
     is_hidden: bool
     form: list[Property] | None = Field(None)

openadmin_dev-0.7.8/openadmin/spec/markdown.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 MarkdownComponent(BaseModel):
+    type: Literal["markdown"]
+    id: str
+    name: str
+    description: str | None
+    color: Color | None
+    icon: Icon | None
+    url: str
+    method: HttpMethod
+    query: list[Property] | None = Field(None)
+
+
+type MarkdownContent = str
+
+
+class MarkdownResponse(TypedDict):
+    icon: NotRequired[Icon]
+    color: NotRequired[Color]
+    content: MarkdownContent
+
+
+type Markdown = MarkdownContent | MarkdownResponse

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/pyproject.toml

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

{openadmin_dev-0.7.5 → openadmin_dev-0.7.8}/uv.lock

@@ -510,7 +510,7 @@ wheels = [
 
 [[package]]
 name = "openadmin"
-version = "0.7.4"
+version = "0.7.8"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi", extra = ["standard"] },

openadmin_dev-0.7.5/openadmin/spec/markdown.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 Markdown(BaseModel):
-    type: Literal["markdown"]
-    id: str
-    name: str
-    description: str | None
-    url: str
-    method: HttpMethod
-    query: list[Property] | None = Field(None)