fastadmin 0.4.9__tar.gz → 0.6.0__tar.gz

fastadmin-0.6.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: fastadmin
+Version: 0.6.0
+Summary: FastAdmin is an easy-to-use Admin Dashboard App for FastAPI/Flask/Django inspired by Django Admin.
+Keywords: admin,dashboard,fastapi,flask,django,tortoise-orm,sqlalchemy,pony,admin-dashboard,django-admin
+Author: Seva D
+Author-email: Seva D <vsdudakov@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.md
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Django
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Widget Sets
+Classifier: Typing :: Typed
+Requires-Dist: pyjwt>=2.6
+Requires-Dist: asgiref>=3.11
+Requires-Dist: django>=6,<7 ; extra == 'django'
+Requires-Dist: fastapi>=0.100,<1 ; extra == 'fastapi'
+Requires-Dist: python-multipart>=0.0.5,<1 ; extra == 'fastapi'
+Requires-Dist: flask>=3,<4 ; extra == 'flask'
+Requires-Dist: pony>=0.7,<1 ; extra == 'pony'
+Requires-Dist: sqlalchemy[asyncio]>=2,<3 ; extra == 'sqlalchemy'
+Requires-Dist: greenlet>=3 ; extra == 'sqlalchemy'
+Requires-Dist: tortoise-orm>=1,<2 ; extra == 'tortoise-orm'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://vsdudakov.github.io/fastadmin/
+Project-URL: Repository, https://github.com/vsdudakov/fastadmin
+Project-URL: Documentation, https://vsdudakov.github.io/fastadmin/
+Project-URL: Issues, https://github.com/vsdudakov/fastadmin/issues
+Provides-Extra: django
+Provides-Extra: fastapi
+Provides-Extra: flask
+Provides-Extra: pony
+Provides-Extra: sqlalchemy
+Provides-Extra: tortoise-orm
+Description-Content-Type: text/markdown
+
+<h1 align="center">FastAdmin — Admin Dashboard for FastAPI, Flask and Django</h1>
+
+<p align="center">
+  <a href="https://github.com/vsdudakov/fastadmin/actions/workflows/ci.yml"><img src="https://github.com/vsdudakov/fastadmin/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://app.codecov.io/gh/vsdudakov/fastadmin"><img src="https://codecov.io/gh/vsdudakov/fastadmin/branch/main/graph/badge.svg?token=RNGX5HOW3T" alt="codecov"></a>
+  <a href="https://pypi.org/project/fastadmin/"><img src="https://badgen.net/pypi/v/fastadmin" alt="PyPI"></a>
+  <a href="https://pypi.org/project/fastadmin/"><img src="https://img.shields.io/badge/python-3.12%2B-blue.svg" alt="Python 3.12+"></a>
+  <a href="https://github.com/vsdudakov/fastadmin/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/vsdudakov/fastadmin" alt="License: MIT"></a>
+</p>
+
+**FastAdmin** is an easy-to-use **admin dashboard (admin panel) for FastAPI, Flask and
+Django**, inspired by Django Admin. It gives your Python web application a
+production-ready **CRUD admin interface** in minutes — on top of **Tortoise ORM,
+Django ORM, SQLAlchemy or Pony ORM** — with authentication, filters, search,
+inline editing, file uploads, CSV/JSON export and dashboard charts out of the box.
+
+FastAdmin is built with relationships in mind and admiration for Django Admin.
+It aims to be minimal, functional and familiar: if you know Django Admin, you
+already know FastAdmin.
+
+📚 **Documentation: [https://vsdudakov.github.io/fastadmin/](https://vsdudakov.github.io/fastadmin/)**
+
+## Demo
+
+![FastAdmin demo — admin panel for FastAPI, Flask and Django](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/images/demo.gif)
+
+## Features
+
+- **Familiar Django-Admin-style API** — `list_display`, `list_filter`,
+  `search_fields`, `fieldsets`, `readonly_fields`, inlines, actions and more.
+- **Any web framework** — mount as a FastAPI sub-app, a Flask blueprint or
+  Django urlpatterns.
+- **Any ORM** — first-class admin classes for Tortoise ORM, Django ORM,
+  SQLAlchemy (async) and Pony ORM.
+- **Authentication & permissions** — pluggable sign-in against your own user
+  model, per-action permission hooks, request/user context in every admin method.
+- **Rich form widgets** — 20+ antd-based widgets (rich text, JSON, async
+  select, phone, slug, date/time pickers, switches, radio groups, …) via
+  `formfield_overrides`.
+- **File & image uploads** — storage-agnostic `upload_file` hook and
+  presigned-URL support via `get_file_url` (local disk, S3, …).
+- **Dashboard widgets** — declarative line/area/column/bar/pie charts and
+  action widgets with filters, powered by antd charts.
+- **Bulk actions & export** — custom bulk actions, CSV/JSON export.
+- **Quality** — fully typed and linted (ruff + ty), 100% backend test coverage,
+  modern React (Vite + antd) frontend bundled with the package — no Node.js
+  needed at install time.
+
+## Installation
+
+Install with the extras matching your web framework and ORM (each combination
+works standalone):
+
+```bash
+pip install fastadmin[fastapi,django]        # FastAPI with Django ORM
+pip install fastadmin[fastapi,tortoise-orm]  # FastAPI with Tortoise ORM
+pip install fastadmin[fastapi,pony]          # FastAPI with Pony ORM
+pip install fastadmin[fastapi,sqlalchemy]    # FastAPI with SQLAlchemy (includes greenlet)
+pip install fastadmin[django]                # Django with Django ORM
+pip install fastadmin[django,pony]           # Django with Pony ORM
+pip install fastadmin[flask,sqlalchemy]      # Flask with SQLAlchemy (includes greenlet)
+```
+
+> **Note:** on zsh (the default macOS shell) quote the extras: `pip install 'fastadmin[fastapi,django]'`.
+
+Configure the required settings:
+
+```bash
+export ADMIN_USER_MODEL=User
+export ADMIN_USER_MODEL_USERNAME_FIELD=username
+export ADMIN_SECRET_KEY=secret_key
+```
+
+## Quick start
+
+```python
+import bcrypt
+from fastapi import FastAPI
+
+from fastadmin import TortoiseModelAdmin, register
+from fastadmin import fastapi_app as admin_app
+
+from models import User
+
+
+@register(User)
+class UserAdmin(TortoiseModelAdmin):
+    exclude = ("hash_password",)
+    list_display = ("id", "username", "is_superuser", "is_active")
+    list_display_links = ("id", "username")
+    list_filter = ("id", "username", "is_superuser", "is_active")
+    search_fields = ("username",)
+
+    async def authenticate(self, username: str, password: str) -> int | None:
+        user = await User.filter(username=username, is_superuser=True).first()
+        if not user:
+            return None
+        if not bcrypt.checkpw(password.encode(), user.hash_password.encode()):
+            return None
+        return user.id
+
+    async def change_password(self, id: int, password: str) -> None:
+        user = await User.filter(id=id).first()
+        if not user:
+            return
+        user.hash_password = bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
+        await user.save(update_fields=("hash_password",))
+
+
+app = FastAPI()
+app.mount("/admin", admin_app)
+```
+
+Run `uvicorn example:app` and open `http://localhost:8000/admin`.
+
+Mounting for the other frameworks:
+
+```python
+# Flask
+from fastadmin import flask_app as admin_app
+app.register_blueprint(admin_app, url_prefix="/admin")
+
+# Django (urls.py)
+from fastadmin import get_django_admin_urls as get_admin_urls
+urlpatterns = [path("admin/", get_admin_urls())]
+```
+
+## Documentation
+
+Full documentation lives at
+**[vsdudakov.github.io/fastadmin](https://vsdudakov.github.io/fastadmin/)**:
+
+- [Installation](https://vsdudakov.github.io/fastadmin/getting-started/installation/)
+  and [Quick start](https://vsdudakov.github.io/fastadmin/getting-started/quickstart/)
+- [Settings](https://vsdudakov.github.io/fastadmin/guides/settings/) — all environment variables
+- [Registering models](https://vsdudakov.github.io/fastadmin/guides/registering-models/) — complete runnable examples for all four ORMs
+- [Authentication](https://vsdudakov.github.io/fastadmin/guides/authentication/) and permissions
+- [Model admins](https://vsdudakov.github.io/fastadmin/guides/model-admins/) — attributes, actions, display fields, exports
+- [Form widgets & file uploads](https://vsdudakov.github.io/fastadmin/guides/form-widgets/)
+- [Inline admins](https://vsdudakov.github.io/fastadmin/guides/inline-admins/)
+- [Dashboard widgets](https://vsdudakov.github.io/fastadmin/guides/dashboard-widgets/) — charts and actions
+- [API reference](https://vsdudakov.github.io/fastadmin/api-reference/)
+
+Runnable example apps for every framework/ORM combination are in
+[`examples/`](https://github.com/vsdudakov/fastadmin/tree/main/examples).
+
+## Why FastAdmin?
+
+If you are looking for a **Django-Admin-like admin panel for FastAPI**, an
+**admin interface for SQLAlchemy or Tortoise ORM**, or a lightweight
+**alternative to building a custom back office**, FastAdmin gives you a
+batteries-included, themeable admin UI without code generation, without tying
+your app to a specific framework, and without writing a single React component.
+
+## Contributing
+
+Contributions are welcome — see the
+[contributing guide](https://vsdudakov.github.io/fastadmin/contributing/).
+Development uses `uv` and `make`: `make dev`, `make lint`, `make test`.
+See [CHANGELOG.md](https://github.com/vsdudakov/fastadmin/blob/main/CHANGELOG.md)
+for release history.
+
+If you have questions beyond the documentation, feel free to
+[email us](mailto:vsdudakov@gmail.com).
+
+## License
+
+FastAdmin is released under the
+[MIT License](https://github.com/vsdudakov/fastadmin/blob/main/LICENSE.md).

fastadmin-0.6.0/README.md

@@ -0,0 +1,169 @@
+<h1 align="center">FastAdmin — Admin Dashboard for FastAPI, Flask and Django</h1>
+
+<p align="center">
+  <a href="https://github.com/vsdudakov/fastadmin/actions/workflows/ci.yml"><img src="https://github.com/vsdudakov/fastadmin/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://app.codecov.io/gh/vsdudakov/fastadmin"><img src="https://codecov.io/gh/vsdudakov/fastadmin/branch/main/graph/badge.svg?token=RNGX5HOW3T" alt="codecov"></a>
+  <a href="https://pypi.org/project/fastadmin/"><img src="https://badgen.net/pypi/v/fastadmin" alt="PyPI"></a>
+  <a href="https://pypi.org/project/fastadmin/"><img src="https://img.shields.io/badge/python-3.12%2B-blue.svg" alt="Python 3.12+"></a>
+  <a href="https://github.com/vsdudakov/fastadmin/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/vsdudakov/fastadmin" alt="License: MIT"></a>
+</p>
+
+**FastAdmin** is an easy-to-use **admin dashboard (admin panel) for FastAPI, Flask and
+Django**, inspired by Django Admin. It gives your Python web application a
+production-ready **CRUD admin interface** in minutes — on top of **Tortoise ORM,
+Django ORM, SQLAlchemy or Pony ORM** — with authentication, filters, search,
+inline editing, file uploads, CSV/JSON export and dashboard charts out of the box.
+
+FastAdmin is built with relationships in mind and admiration for Django Admin.
+It aims to be minimal, functional and familiar: if you know Django Admin, you
+already know FastAdmin.
+
+📚 **Documentation: [https://vsdudakov.github.io/fastadmin/](https://vsdudakov.github.io/fastadmin/)**
+
+## Demo
+
+![FastAdmin demo — admin panel for FastAPI, Flask and Django](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/images/demo.gif)
+
+## Features
+
+- **Familiar Django-Admin-style API** — `list_display`, `list_filter`,
+  `search_fields`, `fieldsets`, `readonly_fields`, inlines, actions and more.
+- **Any web framework** — mount as a FastAPI sub-app, a Flask blueprint or
+  Django urlpatterns.
+- **Any ORM** — first-class admin classes for Tortoise ORM, Django ORM,
+  SQLAlchemy (async) and Pony ORM.
+- **Authentication & permissions** — pluggable sign-in against your own user
+  model, per-action permission hooks, request/user context in every admin method.
+- **Rich form widgets** — 20+ antd-based widgets (rich text, JSON, async
+  select, phone, slug, date/time pickers, switches, radio groups, …) via
+  `formfield_overrides`.
+- **File & image uploads** — storage-agnostic `upload_file` hook and
+  presigned-URL support via `get_file_url` (local disk, S3, …).
+- **Dashboard widgets** — declarative line/area/column/bar/pie charts and
+  action widgets with filters, powered by antd charts.
+- **Bulk actions & export** — custom bulk actions, CSV/JSON export.
+- **Quality** — fully typed and linted (ruff + ty), 100% backend test coverage,
+  modern React (Vite + antd) frontend bundled with the package — no Node.js
+  needed at install time.
+
+## Installation
+
+Install with the extras matching your web framework and ORM (each combination
+works standalone):
+
+```bash
+pip install fastadmin[fastapi,django]        # FastAPI with Django ORM
+pip install fastadmin[fastapi,tortoise-orm]  # FastAPI with Tortoise ORM
+pip install fastadmin[fastapi,pony]          # FastAPI with Pony ORM
+pip install fastadmin[fastapi,sqlalchemy]    # FastAPI with SQLAlchemy (includes greenlet)
+pip install fastadmin[django]                # Django with Django ORM
+pip install fastadmin[django,pony]           # Django with Pony ORM
+pip install fastadmin[flask,sqlalchemy]      # Flask with SQLAlchemy (includes greenlet)
+```
+
+> **Note:** on zsh (the default macOS shell) quote the extras: `pip install 'fastadmin[fastapi,django]'`.
+
+Configure the required settings:
+
+```bash
+export ADMIN_USER_MODEL=User
+export ADMIN_USER_MODEL_USERNAME_FIELD=username
+export ADMIN_SECRET_KEY=secret_key
+```
+
+## Quick start
+
+```python
+import bcrypt
+from fastapi import FastAPI
+
+from fastadmin import TortoiseModelAdmin, register
+from fastadmin import fastapi_app as admin_app
+
+from models import User
+
+
+@register(User)
+class UserAdmin(TortoiseModelAdmin):
+    exclude = ("hash_password",)
+    list_display = ("id", "username", "is_superuser", "is_active")
+    list_display_links = ("id", "username")
+    list_filter = ("id", "username", "is_superuser", "is_active")
+    search_fields = ("username",)
+
+    async def authenticate(self, username: str, password: str) -> int | None:
+        user = await User.filter(username=username, is_superuser=True).first()
+        if not user:
+            return None
+        if not bcrypt.checkpw(password.encode(), user.hash_password.encode()):
+            return None
+        return user.id
+
+    async def change_password(self, id: int, password: str) -> None:
+        user = await User.filter(id=id).first()
+        if not user:
+            return
+        user.hash_password = bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
+        await user.save(update_fields=("hash_password",))
+
+
+app = FastAPI()
+app.mount("/admin", admin_app)
+```
+
+Run `uvicorn example:app` and open `http://localhost:8000/admin`.
+
+Mounting for the other frameworks:
+
+```python
+# Flask
+from fastadmin import flask_app as admin_app
+app.register_blueprint(admin_app, url_prefix="/admin")
+
+# Django (urls.py)
+from fastadmin import get_django_admin_urls as get_admin_urls
+urlpatterns = [path("admin/", get_admin_urls())]
+```
+
+## Documentation
+
+Full documentation lives at
+**[vsdudakov.github.io/fastadmin](https://vsdudakov.github.io/fastadmin/)**:
+
+- [Installation](https://vsdudakov.github.io/fastadmin/getting-started/installation/)
+  and [Quick start](https://vsdudakov.github.io/fastadmin/getting-started/quickstart/)
+- [Settings](https://vsdudakov.github.io/fastadmin/guides/settings/) — all environment variables
+- [Registering models](https://vsdudakov.github.io/fastadmin/guides/registering-models/) — complete runnable examples for all four ORMs
+- [Authentication](https://vsdudakov.github.io/fastadmin/guides/authentication/) and permissions
+- [Model admins](https://vsdudakov.github.io/fastadmin/guides/model-admins/) — attributes, actions, display fields, exports
+- [Form widgets & file uploads](https://vsdudakov.github.io/fastadmin/guides/form-widgets/)
+- [Inline admins](https://vsdudakov.github.io/fastadmin/guides/inline-admins/)
+- [Dashboard widgets](https://vsdudakov.github.io/fastadmin/guides/dashboard-widgets/) — charts and actions
+- [API reference](https://vsdudakov.github.io/fastadmin/api-reference/)
+
+Runnable example apps for every framework/ORM combination are in
+[`examples/`](https://github.com/vsdudakov/fastadmin/tree/main/examples).
+
+## Why FastAdmin?
+
+If you are looking for a **Django-Admin-like admin panel for FastAPI**, an
+**admin interface for SQLAlchemy or Tortoise ORM**, or a lightweight
+**alternative to building a custom back office**, FastAdmin gives you a
+batteries-included, themeable admin UI without code generation, without tying
+your app to a specific framework, and without writing a single React component.
+
+## Contributing
+
+Contributions are welcome — see the
+[contributing guide](https://vsdudakov.github.io/fastadmin/contributing/).
+Development uses `uv` and `make`: `make dev`, `make lint`, `make test`.
+See [CHANGELOG.md](https://github.com/vsdudakov/fastadmin/blob/main/CHANGELOG.md)
+for release history.
+
+If you have questions beyond the documentation, feel free to
+[email us](mailto:vsdudakov@gmail.com).
+
+## License
+
+FastAdmin is released under the
+[MIT License](https://github.com/vsdudakov/fastadmin/blob/main/LICENSE.md).

{fastadmin-0.4.9 → fastadmin-0.6.0}/fastadmin/api/frameworks/django/app/api.py

@@ -78,7 +78,13 @@ async def sign_in(request: HttpRequest) -> JsonResponse:
         )
 
         response = JsonResponse({})
-        response.set_cookie(settings.ADMIN_SESSION_ID_KEY, value=session_id, httponly=True)
+        response.set_cookie(
+            settings.ADMIN_SESSION_ID_KEY,
+            value=session_id,
+            httponly=True,
+            secure=settings.ADMIN_SESSION_COOKIE_SECURE,
+            samesite=settings.ADMIN_SESSION_COOKIE_SAMESITE.capitalize(),
+        )
         return response
 
     except AdminApiException as e:
@@ -317,7 +323,7 @@ async def upload_file(
 
 
 @csrf_exempt
-async def export(request: HttpRequest, model: str) -> JsonResponse:
+async def export(request: HttpRequest, model: str) -> JsonResponse | StreamingHttpResponse:
     """This method is used to export a list of objects.
 
     :params request: a request object.

{fastadmin-0.4.9 → fastadmin-0.6.0}/fastadmin/api/frameworks/fastapi/api.py

@@ -49,7 +49,13 @@ async def sign_in(
             request=request,
         )
 
-        response.set_cookie(settings.ADMIN_SESSION_ID_KEY, value=session_id, httponly=True)
+        response.set_cookie(
+            settings.ADMIN_SESSION_ID_KEY,
+            value=session_id,
+            httponly=True,
+            secure=settings.ADMIN_SESSION_COOKIE_SECURE,
+            samesite=settings.ADMIN_SESSION_COOKIE_SAMESITE,  # ty: ignore[invalid-argument-type]
+        )
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail) from None
 
@@ -307,7 +313,7 @@ async def export(
         )
         headers = {"Content-Disposition": f'attachment; filename="{file_name}"'}
         return StreamingResponse(
-            stream,  # type: ignore [arg-type]
+            stream,  # ty: ignore[invalid-argument-type]
             headers=headers,
             media_type=content_type,
         )

{fastadmin-0.4.9 → fastadmin-0.6.0}/fastadmin/api/frameworks/fastapi/app.py

@@ -25,7 +25,9 @@ app.include_router(views_router)
 
 @app.exception_handler(Exception)
 async def exception_handler(_: Request, exc: Exception):
+    # Log the real error server-side but never leak internals to the client.
+    logger.error("Unhandled admin error: %s", exc)
     return JSONResponse(
         status_code=500,
-        content={"exception": str(exc)},
+        content={"exception": "Internal server error."},
     )

{fastadmin-0.4.9 → fastadmin-0.6.0}/fastadmin/api/frameworks/flask/api.py

@@ -42,7 +42,13 @@ async def sign_in() -> Response:
             request=request,
         )
         response = make_response({})
-        response.set_cookie(settings.ADMIN_SESSION_ID_KEY, value=session_id, httponly=True)
+        response.set_cookie(
+            settings.ADMIN_SESSION_ID_KEY,
+            value=session_id,
+            httponly=True,
+            secure=settings.ADMIN_SESSION_COOKIE_SECURE,
+            samesite=settings.ADMIN_SESSION_COOKIE_SAMESITE.capitalize(),
+        )
         return response
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
@@ -188,7 +194,7 @@ async def add(model: str) -> dict:
         raise http_exception from e
 
 
-@api_router.route("/change-password/<string:id>", methods=["PATCH"])  # type: ignore [type-var]
+@api_router.route("/change-password/<string:id>", methods=["PATCH"])  # ty: ignore[invalid-argument-type]
 async def change_password(id: UUID | int | str) -> UUID | int | str:
     """This method is used to change password.
 
@@ -322,7 +328,7 @@ async def export(model: str) -> Response:
         raise http_exception from e
 
 
-@api_router.route("/delete/<string:model>/<string:id>", methods=["DELETE"])  # type: ignore [type-var]
+@api_router.route("/delete/<string:model>/<string:id>", methods=["DELETE"])  # ty: ignore[invalid-argument-type]
 async def delete(
     model: str,
     id: UUID | int | str,

{fastadmin-0.4.9 → fastadmin-0.6.0}/fastadmin/api/helpers.py

@@ -84,15 +84,8 @@ def is_valid_id(id: UUID | int | str) -> bool:
     :return: True if id is a valid id, False otherwise.
     """
     if isinstance(id, str):
-        if not id:
-            return False
-        if is_valid_uuid(id):
-            return True
-        try:
-            int(id)
-            return True
-        except ValueError:
-            return True  # string PK (e.g. non-numeric)
+        # Any non-empty string is a valid PK (UUID, numeric, or opaque string PK).
+        return bool(id)
     if is_valid_uuid(str(id)):
         return True
     try: