fastadmin 0.1.41__tar.gz → 0.2.1__tar.gz

{fastadmin-0.1.41 → fastadmin-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastadmin
-Version: 0.1.41
+Version: 0.2.1
 Summary: 
 Home-page: https://github.com/vsdudakov/fastadmin
 License: MIT
@@ -17,6 +17,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Widget Sets
@@ -26,14 +27,13 @@ Provides-Extra: flask
 Provides-Extra: pony
 Provides-Extra: sqlalchemy
 Provides-Extra: tortoise-orm
-Requires-Dist: asgiref (>=3.6.0,<4.0.0)
+Requires-Dist: asgiref (==3.6.0)
 Requires-Dist: django (==4.*) ; extra == "django"
 Requires-Dist: fastapi (==0.*) ; extra == "fastapi"
 Requires-Dist: flask (==2.*) ; extra == "flask"
-Requires-Dist: isort (>=5.12.0,<6.0.0)
+Requires-Dist: greenlet (>=3.0.3,<4.0.0)
 Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
 Requires-Dist: pony (==0.*) ; extra == "pony"
-Requires-Dist: pydantic (>=1.10.7,<2.0.0)
 Requires-Dist: pyjwt (>=2.6.0,<3.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
 Requires-Dist: sqlalchemy (==2.*) ; extra == "sqlalchemy"
@@ -65,7 +65,7 @@ Description-Content-Type: text/markdown
 
 ## Introduction
 
-
+  
 <a href='https://github.com/vsdudakov/fastadmin' target='_blank'>FastAdmin</a> is an easy-to-use Admin Dashboard App for FastAPI/Django/Flask inspired by Django Admin.
 
 
@@ -81,7 +81,7 @@ Description-Content-Type: text/markdown
 
 
 
-
+  
 FastAdmin was built with relations in mind and admiration for the excellent and popular Django Admin. It's engraved in its design that you may configure your admin dashboard for FastAPI/Django/Flask easiest way.
 
 
@@ -97,7 +97,7 @@ FastAdmin was built with relations in mind and admiration for the excellent and
 
 
 
-
+  
 FastAdmin is designed to be minimalistic, functional and yet familiar.
 
 
@@ -119,7 +119,7 @@ FastAdmin is designed to be minimalistic, functional and yet familiar.
 
 ## Getting Started
 
-
+  
 
 
 
@@ -139,7 +139,7 @@ If you have any questions that are beyond the scope of the documentation, Please
 
 ### Installation
 
-
+  
 
 
 Follow the steps below to setup FastAdmin:
@@ -155,7 +155,7 @@ Follow the steps below to setup FastAdmin:
 
 
 
-
+  
 Install the package using pip:
 
 
@@ -171,7 +171,7 @@ Install the package using pip:
 
 
 
-
+  
 
 
 
@@ -187,7 +187,7 @@ Note: For zsh and macos use: <code>pip install fastadmin[fastapi,django]</code>
 
 
 
-
+  
 
 
 
@@ -213,7 +213,7 @@ pip install fastadmin[flask,sqlalchemy]  # for flask with sqlalchemy
 
 
 
-
+  
 Install the package using poetry:
 
 
@@ -229,7 +229,7 @@ Install the package using poetry:
 
 
 
-
+  
 
 
 
@@ -255,7 +255,7 @@ poetry add 'fastadmin[flask,sqlalchemy]'  # for flask with sqlalchemy
 
 
 
-
+  
 Configure required settings using virtual environment variables:
 
 
@@ -271,7 +271,7 @@ Configure required settings using virtual environment variables:
 
 
 
-
+  
 
 
 
@@ -287,7 +287,7 @@ Note: You can add these variables to .env and use python-dotenv to load them. Se
 
 
 
-
+  
 
 
 
@@ -312,7 +312,7 @@ export ADMIN_SECRET_KEY=secret_key
 
 ### Quick Tutorial
 
-
+  
 
 
 Setup FastAdmin for a framework
@@ -328,7 +328,7 @@ Setup FastAdmin for a framework
 
 
 
-
+  
 
 
 
@@ -432,7 +432,7 @@ app.register_blueprint(admin_app, url_prefix="/admin")
 
 
 
-
+  
 
 
 Register ORM models
@@ -448,7 +448,7 @@ Register ORM models
 
 
 
-
+  
 
 
 
@@ -722,4 +722,3 @@ See full documentation [here](https://vsdudakov.github.io/fastadmin).
 
 ## License
 This project is licensed under the MIT License - see the [LICENSE](https://github.com/vsdudakov/fastadmin/blob/main/LICENSE) file for details.
-

{fastadmin-0.1.41 → fastadmin-0.2.1}/README.md

@@ -22,7 +22,7 @@
 
 ## Introduction
 
-
+  
 <a href='https://github.com/vsdudakov/fastadmin' target='_blank'>FastAdmin</a> is an easy-to-use Admin Dashboard App for FastAPI/Django/Flask inspired by Django Admin.
 
 
@@ -38,7 +38,7 @@
 
 
 
-
+  
 FastAdmin was built with relations in mind and admiration for the excellent and popular Django Admin. It's engraved in its design that you may configure your admin dashboard for FastAPI/Django/Flask easiest way.
 
 
@@ -54,7 +54,7 @@ FastAdmin was built with relations in mind and admiration for the excellent and
 
 
 
-
+  
 FastAdmin is designed to be minimalistic, functional and yet familiar.
 
 
@@ -76,7 +76,7 @@ FastAdmin is designed to be minimalistic, functional and yet familiar.
 
 ## Getting Started
 
-
+  
 
 
 
@@ -96,7 +96,7 @@ If you have any questions that are beyond the scope of the documentation, Please
 
 ### Installation
 
-
+  
 
 
 Follow the steps below to setup FastAdmin:
@@ -112,7 +112,7 @@ Follow the steps below to setup FastAdmin:
 
 
 
-
+  
 Install the package using pip:
 
 
@@ -128,7 +128,7 @@ Install the package using pip:
 
 
 
-
+  
 
 
 
@@ -144,7 +144,7 @@ Note: For zsh and macos use: <code>pip install fastadmin[fastapi,django]</code>
 
 
 
-
+  
 
 
 
@@ -170,7 +170,7 @@ pip install fastadmin[flask,sqlalchemy]  # for flask with sqlalchemy
 
 
 
-
+  
 Install the package using poetry:
 
 
@@ -186,7 +186,7 @@ Install the package using poetry:
 
 
 
-
+  
 
 
 
@@ -212,7 +212,7 @@ poetry add 'fastadmin[flask,sqlalchemy]'  # for flask with sqlalchemy
 
 
 
-
+  
 Configure required settings using virtual environment variables:
 
 
@@ -228,7 +228,7 @@ Configure required settings using virtual environment variables:
 
 
 
-
+  
 
 
 
@@ -244,7 +244,7 @@ Note: You can add these variables to .env and use python-dotenv to load them. Se
 
 
 
-
+  
 
 
 
@@ -269,7 +269,7 @@ export ADMIN_SECRET_KEY=secret_key
 
 ### Quick Tutorial
 
-
+  
 
 
 Setup FastAdmin for a framework
@@ -285,7 +285,7 @@ Setup FastAdmin for a framework
 
 
 
-
+  
 
 
 
@@ -389,7 +389,7 @@ app.register_blueprint(admin_app, url_prefix="/admin")
 
 
 
-
+  
 
 
 Register ORM models
@@ -405,7 +405,7 @@ Register ORM models
 
 
 
-
+  
 
 
 
@@ -678,4 +678,4 @@ class UserAdmin(PonyORMModelAdmin):
 See full documentation [here](https://vsdudakov.github.io/fastadmin).
 
 ## License
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/vsdudakov/fastadmin/blob/main/LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/vsdudakov/fastadmin/blob/main/LICENSE) file for details.

{fastadmin-0.1.41 → fastadmin-0.2.1}/fastadmin/api/frameworks/fastapi/api.py

@@ -117,7 +117,7 @@ async def list_objs(
     request: Request,
     model: str,
     search: str | None = None,
-    sort_by: str = None,
+    sort_by: str | None = None,
     offset: int | None = 0,
     limit: int | None = 10,
 ):
@@ -238,7 +238,7 @@ async def export(
     model: str,
     payload: ExportInputSchema,
     search: str | None = None,
-    sort_by: str = None,
+    sort_by: str | None = None,
 ):
     """This method is used to export a list of objects.
 

{fastadmin-0.1.41 → fastadmin-0.2.1}/fastadmin/api/frameworks/flask/api.py

@@ -37,7 +37,7 @@ async def sign_in() -> Response:
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/sign-out", methods=["POST"])
@@ -57,7 +57,7 @@ async def sign_out() -> Response:
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/me", methods=["GET"])
@@ -79,7 +79,7 @@ async def me() -> dict:
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/dashboard-widget/<string:model>", methods=["GET"])
@@ -109,7 +109,7 @@ async def dashboard_widget(model: str) -> dict:
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/list/<string:model>", methods=["GET"])
@@ -143,14 +143,14 @@ async def list_objs(model: str) -> dict:
             "total": total,
             "results": objs,
         }
-    except ValueError:
+    except ValueError as e:
         http_exception = HTTPException("Invalid format of get parameters")
         http_exception.code = 422
-        raise http_exception
+        raise http_exception from e
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/retrieve/<string:model>/<string:id>", methods=["GET"])
@@ -174,7 +174,7 @@ async def get(model: str, id: UUID | int) -> dict:
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/add/<string:model>", methods=["POST"])
@@ -195,7 +195,7 @@ async def add(model: str) -> dict:
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/change-password/<string:id>", methods=["PATCH"])  # type: ignore [type-var]
@@ -221,7 +221,7 @@ async def change_password(id: UUID | int) -> UUID | int:
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/change/<string:model>/<string:id>", methods=["PATCH"])
@@ -248,7 +248,7 @@ async def change(model: str, id: UUID | int) -> dict:
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/export/<string:model>", methods=["POST"])
@@ -282,7 +282,7 @@ async def export(model: str) -> Response:
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/delete/<string:model>/<string:id>", methods=["DELETE"])  # type: ignore [type-var]
@@ -309,7 +309,7 @@ async def delete(
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/action/<string:model>/<string:action>", methods=["POST"])
@@ -337,7 +337,7 @@ async def action(
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code
-        raise http_exception
+        raise http_exception from e
 
 
 @api_router.route("/configuration", methods=["GET"])

{fastadmin-0.1.41 → fastadmin-0.2.1}/fastadmin/api/helpers.py

@@ -30,12 +30,11 @@ def sanitize_filter_key(key: str, fields: list[ModelFieldWidgetSchema]) -> tuple
     :return: A tuple of sanitized key and condition.
     """
     if "__" not in key:
-        key = f"{key}__exact"
-    field_name = key.split("__", 1)[0]
-    condition = key.split("__", 1)[1]
+        key += "__exact"
+    field_name, _, condition = key.partition("__")
     field: ModelFieldWidgetSchema | None = next((field for field in fields if field.name == field_name), None)
     if field and field.filter_widget_props.get("parentModel") and not field.is_m2m:
-        field_name = f"{field_name}_id"
+        field_name += "_id"
     return field_name, condition
 
 
@@ -52,32 +51,26 @@ def is_valid_uuid(uuid_to_test: str) -> bool:
     return str(uuid_obj) == uuid_to_test
 
 
-def is_digit(digit_to_test: str) -> bool:
-    """Check if digit_to_test is a digit.
-
-    :param digit_to_test: A digit to test.
-    :return: True if digit_to_test is a digit, False otherwise.
-    """
-    try:
-        int(digit_to_test)
-    except ValueError:
-        return False
-    return True
-
-
 def is_valid_id(id: UUID | int) -> bool:
     """Check if id is a valid id.
 
     :param id: An id to test.
     :return: True if id is a valid id, False otherwise.
     """
-    return is_digit(str(id)) or is_valid_uuid(str(id))
+    if is_valid_uuid(str(id)):
+        return True
+    try:
+        int(id)
+        return True
+    except ValueError:
+        pass
+    return False
 
 
 def is_valid_base64(value: str) -> bool:
-    """Check if s is a valid base64.
+    """Check if a string is a valid base64.
 
-    :param s: A string to test.
+    :param value: A string to test.
     :return: True if s is a valid base64, False otherwise.
     """
     try:

{fastadmin-0.1.41 → fastadmin-0.2.1}/fastadmin/api/service.py

@@ -107,7 +107,7 @@ class ApiService:
         if inspect.iscoroutinefunction(admin_model.authenticate):
             authenticate_fn = admin_model.authenticate
         else:
-            authenticate_fn = sync_to_async(admin_model.authenticate)
+            authenticate_fn = sync_to_async(admin_model.authenticate)  # type: ignore [arg-type]
 
         user_id = await authenticate_fn(payload.username, payload.password)
 
@@ -162,7 +162,7 @@ class ApiService:
         if inspect.iscoroutinefunction(dashboard_widget_model.get_data):
             get_data = dashboard_widget_model.get_data
         else:
-            get_data = sync_to_async(dashboard_widget_model.get_data)
+            get_data = sync_to_async(dashboard_widget_model.get_data)  # type: ignore [arg-type]
         data = await get_data(
             min_x_field=query_params.min_x_field,
             max_x_field=query_params.max_x_field,
@@ -178,7 +178,7 @@ class ApiService:
         model: str,
         search: str | None = None,
         sort_by: str | None = None,
-        filters: dict = None,
+        filters: dict | None = None,
         offset: int | None = 0,
         limit: int | None = 10,
     ) -> tuple[list[dict], int]:
@@ -302,7 +302,7 @@ class ApiService:
         if inspect.iscoroutinefunction(admin_model.change_password):
             change_password_fn = admin_model.change_password
         else:
-            change_password_fn = sync_to_async(admin_model.change_password)
+            change_password_fn = sync_to_async(admin_model.change_password)  # type: ignore [arg-type]
         await change_password_fn(id, payload.password)
 
     async def change(
@@ -332,7 +332,7 @@ class ApiService:
         payload: ExportInputSchema,
         search: str | None = None,
         sort_by: str | None = None,
-        filters: dict = None,
+        filters: dict | None = None,
     ) -> tuple[str, str, StringIO | BytesIO | None]:
         current_user_id = await get_user_id_from_session_id(session_id)
         if not current_user_id:

{fastadmin-0.1.41 → fastadmin-0.2.1}/fastadmin/models/base.py

@@ -87,7 +87,7 @@ class BaseModelAdmin:
     # formfield_overrides = {
     #     "description": (WidgetType.RichTextArea, {})
     # }
-    formfield_overrides: dict[str, tuple[WidgetType, dict]] = {}
+    formfield_overrides: dict[str, tuple[WidgetType, dict]] = {}  # noqa: RUF012
 
     # Set list_display to control which fields are displayed on the list page of the admin.
     # If you don't set list_display, the admin site will display a single column that displays the __str__() representation of each object
@@ -104,7 +104,7 @@ class BaseModelAdmin:
     # list_display_widths = {
     #     "id": "100px",
     # }
-    list_display_widths: dict[str, str] = {}
+    list_display_widths: dict[str, str] = {}  # noqa: RUF012
 
     # Set list_filter to activate filters in the tabel columns of the list page of the admin.
     # Example of usage: list_filter = ("is_superuser", "is_active", "created_at")

{fastadmin-0.1.41 → fastadmin-0.2.1}/fastadmin/models/decorators.py

@@ -1,4 +1,4 @@
-def action(function=None, *, description: str = None):
+def action(function=None, *, description: str | None = None):
     """Conveniently add attributes to an action function:
 
     Example of usage:

{fastadmin-0.1.41 → fastadmin-0.2.1}/fastadmin/models/orms/ponyorm.py

@@ -3,7 +3,7 @@ from typing import Any
 from uuid import UUID
 
 from asgiref.sync import sync_to_async
-from pony.orm import commit, db_session, delete, desc, flush, select
+from pony.orm import commit, db_session, desc, flush, select
 
 from fastadmin.models.base import InlineModelAdmin, ModelAdmin
 from fastadmin.models.schemas import ModelFieldWidgetSchema, WidgetType
@@ -233,8 +233,8 @@ class PonyORMMixin:
         :return: A tuple of list of objects and total count.
         """
 
+        # import pdb; pdb.set_trace()
         qs = select(m for m in self.model_cls)
-
         if filters:
             for field_with_condition, value in filters.items():
                 field = field_with_condition[0]
@@ -326,9 +326,9 @@ class PonyORMMixin:
         :params id: an id of object.
         :return: None.
         """
-        delete(o for o in self.model_cls if getattr(o, self.get_model_pk_name(self.model_cls)) == id)
-        flush()
-        commit()
+        # delete(o for o in self.model_cls if getattr(o, self.get_model_pk_name(self.model_cls)) == id)
+        # flush()
+        # commit()
 
     @sync_to_async
     @db_session

fastadmin-0.2.1/fastadmin/static/index.html

@@ -0,0 +1,19 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="Fast Admin"/>
+    <title>Fast Admin</title>
+    <script>
+      window.SERVER_DOMAIN = 'http://localhost:8080';
+      window.SERVER_URL = 'http://localhost:8080/admin/api';
+    </script>
+    <script type="module" crossorigin src="/index.min.js"></script>
+    <link rel="stylesheet" crossorigin href="/index.min.css">
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>