oxyde-admin 0.1.0__tar.gz

oxyde_admin-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nikita Ryzhenkov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

oxyde_admin-0.1.0/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: oxyde-admin
+Version: 0.1.0
+Summary: Admin interface for Oxyde ORM
+Author-email: Nikita Ryzhenkov <nikita.ryzhenkoff@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/mr-fatalyst/oxyde-admin
+Project-URL: Repository, https://github.com/mr-fatalyst/oxyde-admin
+Project-URL: Issues, https://github.com/mr-fatalyst/oxyde-admin/issues
+Keywords: admin,orm,oxyde,crud,dashboard,pydantic
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Pydantic :: 2
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: oxyde>=0.4.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: fastapi; extra == "dev"
+Requires-Dist: litestar; extra == "dev"
+Requires-Dist: sanic; extra == "dev"
+Requires-Dist: uvicorn; extra == "dev"
+Requires-Dist: pyjwt; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="logo.png" alt="Logo" width="300">
+</p>
+
+<p align="center"> <b>Oxyde Admin</b> Auto-generated admin panel for <a href="https://github.com/mr-fatalyst/oxyde">Oxyde ORM</a> with zero boilerplate. </p>
+
+<p align="center">
+  <img src="https://img.shields.io/github/license/mr-fatalyst/oxyde-admin">
+  <img src="https://github.com/mr-fatalyst/oxyde-admin/actions/workflows/test.yml/badge.svg">
+  <img src="https://img.shields.io/pypi/v/oxyde-admin">
+  <img src="https://img.shields.io/pypi/pyversions/oxyde-admin">
+  <img src="https://static.pepy.tech/badge/oxyde-admin" alt="PyPI Downloads">
+</p>
+
+---
+
+## Features
+
+- **Automatic CRUD** -list, create, edit, delete from your Oxyde models
+- **Search & filters** -text search across fields, column filters (FK, bool, string)
+- **Foreign key handling** -select dropdowns with inline create dialog
+- **Export** -CSV and JSON export with applied filters
+- **Authentication** -pluggable auth via callback, JWT-ready
+- **Theming** -3 presets, 17 colors, 8 surface palettes
+- **Bulk operations** -bulk delete and update from list view
+- **Multi-framework** -FastAPI, Litestar and Sanic adapters
+
+![oxyde-admin list view](images/screenshot-list.png)
+
+## Installation
+
+```bash
+pip install oxyde-admin
+```
+
+## Quick start
+
+```python
+from fastapi import FastAPI
+from oxyde import db
+from oxyde_admin import FastAPIAdmin
+
+from models import User, Post, Comment
+
+admin = FastAPIAdmin(title="My Admin")
+admin.register(User, list_display=["name", "email"], search_fields=["name", "email"])
+admin.register(Post, list_display=["title", "is_published"], list_filter=["is_published"])
+admin.register(Comment)
+
+app = FastAPI(lifespan=db.lifespan(default="sqlite:///app.db"))
+app.mount("/admin", admin.app)
+```
+
+Open `http://localhost:8000/admin/` and get a full CRUD interface for your models.
+
+![edit form](images/screenshot-detail.png)
+
+## Frameworks
+
+### FastAPI
+
+```python
+from oxyde_admin import FastAPIAdmin
+
+admin = FastAPIAdmin(title="My Admin")
+# register models...
+app.mount("/admin", admin.app)
+```
+
+### Litestar
+
+```python
+from litestar import Litestar, asgi
+from oxyde_admin import LitestarAdmin
+
+admin = LitestarAdmin(title="My Admin")
+# register models...
+
+app = Litestar(
+    route_handlers=[
+        asgi(path="/admin", is_mount=True)(admin.app),
+    ],
+)
+```
+
+### Sanic
+
+```python
+from sanic import Sanic
+from oxyde_admin import SanicAdmin
+
+admin = SanicAdmin(title="My Admin")
+# register models...
+
+app = Sanic("MyApp")
+admin.register_exception_handlers(app)
+app.blueprint(admin.blueprint)
+```
+
+## Model registration
+
+```python
+admin.register(
+    Post,
+    list_display=["title", "author_id", "is_published", "views"],
+    search_fields=["title", "content"],
+    list_filter=["author_id", "is_published"],
+    readonly_fields=["views"],
+    ordering=["-views"],
+    display_field="title",
+    column_labels={"author_id": "Author", "is_published": "Published"},
+    exportable=True,
+    group="Content",
+    icon="pi pi-file-edit",
+)
+```
+
+| Parameter | Description |
+|---|---|
+| `list_display` | Columns shown in the list view |
+| `search_fields` | Fields included in text search |
+| `list_filter` | Columns available as filters |
+| `readonly_fields` | Fields disabled in the edit form |
+| `ordering` | Default sort order (prefix `-` for descending) |
+| `display_field` | Field used as label in FK dropdowns |
+| `column_labels` | Custom column headers |
+| `exportable` | Enable CSV/JSON export (default: `True`) |
+| `group` | Sidebar group name |
+| `icon` | Sidebar icon ([PrimeIcons](https://primevue.org/icons/)) |
+
+You can also auto-register all models at once:
+
+```python
+admin.register_all()
+
+# or exclude specific models
+admin.register_all(exclude={InternalModel})
+```
+
+## Theming
+
+```python
+from oxyde_admin import Preset, PrimaryColor, Surface
+
+admin = FastAPIAdmin(
+    title="My Admin",
+    preset=Preset.AURA,
+    primary_color=PrimaryColor.TEAL,
+    surface=Surface.ZINC,
+)
+```
+
+![themes](images/screenshot-themes.png)
+
+**Presets:** `AURA`, `LARA`, `NORA`
+
+**Colors:** `NOIR` `EMERALD` `GREEN` `LIME` `ORANGE` `AMBER` `YELLOW` `TEAL` `CYAN` `SKY` `BLUE` `INDIGO` `VIOLET` `PURPLE` `FUCHSIA` `PINK` `ROSE`
+
+**Surfaces:** `SLATE` `GRAY` `ZINC` `NEUTRAL` `STONE` `SOHO` `VIVA` `OCEAN`
+
+## Authentication
+
+Pass an `auth_check` callback and a `login_url`:
+
+```python
+async def check_admin(request) -> bool:
+    token = request.headers.get("Authorization", "").removeprefix("Bearer ")
+    return await verify_admin_token(token)
+
+admin = FastAPIAdmin(
+    auth_check=check_admin,
+    login_url="/auth/login",
+)
+```
+
+The admin UI redirects unauthenticated users to `login_url`. Your login endpoint should return a JSON response with a token - the frontend stores it and sends as `Authorization: Bearer <token>` on every request.
+
+## License
+
+This project is licensed under the terms of the MIT license.

oxyde_admin-0.1.0/README.md

@@ -0,0 +1,180 @@
+<p align="center">
+  <img src="logo.png" alt="Logo" width="300">
+</p>
+
+<p align="center"> <b>Oxyde Admin</b> Auto-generated admin panel for <a href="https://github.com/mr-fatalyst/oxyde">Oxyde ORM</a> with zero boilerplate. </p>
+
+<p align="center">
+  <img src="https://img.shields.io/github/license/mr-fatalyst/oxyde-admin">
+  <img src="https://github.com/mr-fatalyst/oxyde-admin/actions/workflows/test.yml/badge.svg">
+  <img src="https://img.shields.io/pypi/v/oxyde-admin">
+  <img src="https://img.shields.io/pypi/pyversions/oxyde-admin">
+  <img src="https://static.pepy.tech/badge/oxyde-admin" alt="PyPI Downloads">
+</p>
+
+---
+
+## Features
+
+- **Automatic CRUD** -list, create, edit, delete from your Oxyde models
+- **Search & filters** -text search across fields, column filters (FK, bool, string)
+- **Foreign key handling** -select dropdowns with inline create dialog
+- **Export** -CSV and JSON export with applied filters
+- **Authentication** -pluggable auth via callback, JWT-ready
+- **Theming** -3 presets, 17 colors, 8 surface palettes
+- **Bulk operations** -bulk delete and update from list view
+- **Multi-framework** -FastAPI, Litestar and Sanic adapters
+
+![oxyde-admin list view](images/screenshot-list.png)
+
+## Installation
+
+```bash
+pip install oxyde-admin
+```
+
+## Quick start
+
+```python
+from fastapi import FastAPI
+from oxyde import db
+from oxyde_admin import FastAPIAdmin
+
+from models import User, Post, Comment
+
+admin = FastAPIAdmin(title="My Admin")
+admin.register(User, list_display=["name", "email"], search_fields=["name", "email"])
+admin.register(Post, list_display=["title", "is_published"], list_filter=["is_published"])
+admin.register(Comment)
+
+app = FastAPI(lifespan=db.lifespan(default="sqlite:///app.db"))
+app.mount("/admin", admin.app)
+```
+
+Open `http://localhost:8000/admin/` and get a full CRUD interface for your models.
+
+![edit form](images/screenshot-detail.png)
+
+## Frameworks
+
+### FastAPI
+
+```python
+from oxyde_admin import FastAPIAdmin
+
+admin = FastAPIAdmin(title="My Admin")
+# register models...
+app.mount("/admin", admin.app)
+```
+
+### Litestar
+
+```python
+from litestar import Litestar, asgi
+from oxyde_admin import LitestarAdmin
+
+admin = LitestarAdmin(title="My Admin")
+# register models...
+
+app = Litestar(
+    route_handlers=[
+        asgi(path="/admin", is_mount=True)(admin.app),
+    ],
+)
+```
+
+### Sanic
+
+```python
+from sanic import Sanic
+from oxyde_admin import SanicAdmin
+
+admin = SanicAdmin(title="My Admin")
+# register models...
+
+app = Sanic("MyApp")
+admin.register_exception_handlers(app)
+app.blueprint(admin.blueprint)
+```
+
+## Model registration
+
+```python
+admin.register(
+    Post,
+    list_display=["title", "author_id", "is_published", "views"],
+    search_fields=["title", "content"],
+    list_filter=["author_id", "is_published"],
+    readonly_fields=["views"],
+    ordering=["-views"],
+    display_field="title",
+    column_labels={"author_id": "Author", "is_published": "Published"},
+    exportable=True,
+    group="Content",
+    icon="pi pi-file-edit",
+)
+```
+
+| Parameter | Description |
+|---|---|
+| `list_display` | Columns shown in the list view |
+| `search_fields` | Fields included in text search |
+| `list_filter` | Columns available as filters |
+| `readonly_fields` | Fields disabled in the edit form |
+| `ordering` | Default sort order (prefix `-` for descending) |
+| `display_field` | Field used as label in FK dropdowns |
+| `column_labels` | Custom column headers |
+| `exportable` | Enable CSV/JSON export (default: `True`) |
+| `group` | Sidebar group name |
+| `icon` | Sidebar icon ([PrimeIcons](https://primevue.org/icons/)) |
+
+You can also auto-register all models at once:
+
+```python
+admin.register_all()
+
+# or exclude specific models
+admin.register_all(exclude={InternalModel})
+```
+
+## Theming
+
+```python
+from oxyde_admin import Preset, PrimaryColor, Surface
+
+admin = FastAPIAdmin(
+    title="My Admin",
+    preset=Preset.AURA,
+    primary_color=PrimaryColor.TEAL,
+    surface=Surface.ZINC,
+)
+```
+
+![themes](images/screenshot-themes.png)
+
+**Presets:** `AURA`, `LARA`, `NORA`
+
+**Colors:** `NOIR` `EMERALD` `GREEN` `LIME` `ORANGE` `AMBER` `YELLOW` `TEAL` `CYAN` `SKY` `BLUE` `INDIGO` `VIOLET` `PURPLE` `FUCHSIA` `PINK` `ROSE`
+
+**Surfaces:** `SLATE` `GRAY` `ZINC` `NEUTRAL` `STONE` `SOHO` `VIVA` `OCEAN`
+
+## Authentication
+
+Pass an `auth_check` callback and a `login_url`:
+
+```python
+async def check_admin(request) -> bool:
+    token = request.headers.get("Authorization", "").removeprefix("Bearer ")
+    return await verify_admin_token(token)
+
+admin = FastAPIAdmin(
+    auth_check=check_admin,
+    login_url="/auth/login",
+)
+```
+
+The admin UI redirects unauthenticated users to `login_url`. Your login endpoint should return a JSON response with a token - the frontend stores it and sends as `Authorization: Bearer <token>` on every request.
+
+## License
+
+This project is licensed under the terms of the MIT license.

oxyde_admin-0.1.0/oxyde_admin/__init__.py

@@ -0,0 +1,40 @@
+from oxyde_admin._version import __version__
+from oxyde_admin.config import Preset, PrimaryColor, Surface
+
+
+def _make_stub(name, package):
+    class _Stub:
+        def __init__(self, *args, **kwargs):
+            raise ImportError(
+                f"{name} requires '{package}'. Install it with: pip install {package}"
+            )
+
+    _Stub.__name__ = _Stub.__qualname__ = name
+    return _Stub
+
+
+try:
+    from oxyde_admin.adapters._fastapi import FastAPIAdmin
+except ImportError:
+    FastAPIAdmin = _make_stub("FastAPIAdmin", "fastapi")
+
+try:
+    from oxyde_admin.adapters._litestar import LitestarAdmin
+except ImportError:
+    LitestarAdmin = _make_stub("LitestarAdmin", "litestar")
+
+try:
+    from oxyde_admin.adapters._sanic import SanicAdmin
+except ImportError:
+    SanicAdmin = _make_stub("SanicAdmin", "sanic")
+
+
+__all__ = [
+    "__version__",
+    "Preset",
+    "PrimaryColor",
+    "Surface",
+    "FastAPIAdmin",
+    "LitestarAdmin",
+    "SanicAdmin",
+]

oxyde_admin-0.1.0/oxyde_admin/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

oxyde_admin-0.1.0/oxyde_admin/adapters/_fastapi.py

@@ -0,0 +1,185 @@
+from __future__ import annotations
+
+import inspect
+
+from fastapi import FastAPI, Query, Request
+from fastapi.responses import (
+    JSONResponse,
+    HTMLResponse,
+    FileResponse,
+    StreamingResponse,
+)
+from fastapi.staticfiles import StaticFiles
+from starlette.middleware.base import BaseHTTPMiddleware
+
+from oxyde_admin.adapters.base import AbstractAdapter, STATIC_DIR
+
+
+class FastAPIAdmin(AbstractAdapter):
+    """FastAPI adapter for Oxyde Admin."""
+
+    def __init__(self, prefix: str = "/admin", **kwargs) -> None:
+        super().__init__(**kwargs)
+        self.prefix = prefix
+
+    def _build_app(self) -> FastAPI:
+        app = FastAPI(title="Oxyde Admin", docs_url=None, redoc_url=None)
+
+        if self.auth_check is not None:
+            self._register_auth_middleware(app)
+
+        self._register_exception_handlers(app)
+        self._register_routes(app)
+        self._register_static(app)
+
+        return app
+
+    def _register_auth_middleware(self, app: FastAPI) -> None:
+        check = self.auth_check
+
+        async def auth_middleware(request: Request, call_next):
+            root = request.scope.get("root_path", "")
+            raw_path = request.scope.get("path", request.url.path)
+            path = (
+                raw_path[len(root) :]
+                if root and raw_path.startswith(root)
+                else raw_path
+            )
+            if not path.startswith("/api/") or path == "/api/config":
+                return await call_next(request)
+            if inspect.iscoroutinefunction(check):
+                allowed = await check(request)
+            else:
+                allowed = check(request)
+            if not allowed:
+                return JSONResponse({"detail": "Unauthorized"}, status_code=401)
+            return await call_next(request)
+
+        app.add_middleware(BaseHTTPMiddleware, dispatch=auth_middleware)
+
+    def _register_exception_handlers(self, app: FastAPI) -> None:
+        for exc_cls, (status_code, detail_fn) in self.EXCEPTION_MAP.items():
+
+            def _make_handler(_status=status_code, _fn=detail_fn):
+                async def handler(request: Request, exc) -> JSONResponse:
+                    detail = _fn(exc)
+                    return JSONResponse({"detail": detail}, status_code=_status)
+
+                return handler
+
+            app.add_exception_handler(exc_cls, _make_handler())
+
+    def _register_routes(self, app: FastAPI) -> None:
+        @app.get("/api/config")
+        async def admin_config() -> dict:
+            return self._build_config()
+
+        @app.get("/api/models")
+        async def models_list() -> list[dict]:
+            return self._build_models_list()
+
+        @app.get("/api/models/counts")
+        async def models_counts() -> dict[str, int]:
+            return await self._build_models_counts()
+
+        @app.get("/api/{model_name}/schema", response_model=None)
+        async def model_schema(model_name: str):
+            return await self._handle_schema(model_name)
+
+        @app.get("/api/{model_name}", response_model=None)
+        async def model_list(
+            request: Request,
+            model_name: str,
+            page: int = 1,
+            per_page: int = 25,
+            ordering: str | None = None,
+            search: str | None = None,
+        ):
+            return await self._handle_list(
+                model_name,
+                request.query_params,
+                page,
+                per_page,
+                ordering,
+                search,
+            )
+
+        @app.get("/api/{model_name}/options", response_model=None)
+        async def model_options(
+            model_name: str,
+            search: str | None = None,
+            limit: int = 25,
+            include: str | None = None,
+        ):
+            include_list = include.split(",") if include else None
+            return await self._handle_options(
+                model_name, search=search, limit=limit, include=include_list
+            )
+
+        @app.get("/api/{model_name}/export", response_model=None)
+        async def model_export(
+            request: Request,
+            model_name: str,
+            fmt: str = Query("csv", alias="format"),
+            ordering: str | None = None,
+            search: str | None = None,
+            ids: str | None = None,
+        ):
+            id_list = ids.split(",") if ids else None
+            stream, media_type, filename = await self._handle_export(
+                model_name,
+                request.query_params,
+                fmt,
+                ordering,
+                search,
+                ids=id_list,
+            )
+            return StreamingResponse(
+                stream,
+                media_type=media_type,
+                headers={"Content-Disposition": f'attachment; filename="{filename}"'},
+            )
+
+        @app.get("/api/{model_name}/{pk}", response_model=None)
+        async def model_get(model_name: str, pk: str):
+            return await self._handle_get(model_name, pk)
+
+        @app.post("/api/{model_name}", status_code=201, response_model=None)
+        async def model_create(model_name: str, request: Request):
+            data = await request.json()
+            return await self._handle_create(model_name, data)
+
+        @app.put("/api/{model_name}/{pk}", response_model=None)
+        async def model_update(model_name: str, pk: str, request: Request):
+            data = await request.json()
+            return await self._handle_update(model_name, pk, data)
+
+        @app.delete("/api/{model_name}/{pk}", response_model=None)
+        async def model_delete(model_name: str, pk: str):
+            return await self._handle_delete(model_name, pk)
+
+        @app.post("/api/{model_name}/bulk-delete", response_model=None)
+        async def model_bulk_delete(model_name: str, request: Request):
+            body = await request.json()
+            return await self._handle_bulk_delete(model_name, body["ids"])
+
+        @app.post("/api/{model_name}/bulk-update", response_model=None)
+        async def model_bulk_update(model_name: str, request: Request):
+            body = await request.json()
+            return await self._handle_bulk_update(model_name, body["ids"], body["data"])
+
+    def _register_static(self, app: FastAPI) -> None:
+        assets_dir = STATIC_DIR / "assets"
+        if assets_dir.is_dir():
+            app.mount("/assets", StaticFiles(directory=assets_dir), name="static")
+
+        @app.get("/{path:path}", response_model=None)
+        async def catch_all(request: Request, path: str):
+            static_file = self._resolve_static_file(path)
+            if static_file is not None:
+                return FileResponse(static_file)
+            root = request.scope.get("root_path", "")
+            html = self._render_index_html(root)
+            if html is not None:
+                return HTMLResponse(html)
+            return JSONResponse({"detail": "Frontend not built"}, status_code=404)