fastadmin 0.1.15__tar.gz → 0.1.17__tar.gz

{fastadmin-0.1.15 → fastadmin-0.1.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastadmin
-Version: 0.1.15
+Version: 0.1.17
 Summary: 
 Home-page: https://github.com/vsdudakov/fastadmin
 License: MIT
@@ -39,6 +39,12 @@ Description-Content-Type: text/markdown
 ![List View](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/images/list.png)
 ![Change View](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/images/change.png)
 
+<p align="center">
+  <a href="https://twitter.com/intent/tweet?text=Admin%20Dashboard%20For%20FastAPI&url=https://github.com/vsdudakov/fastadmin&hashtags=FastAPI,AdminDashboard">
+    <img alt="tweet" src="https://img.shields.io/twitter/url/https/twitter?label=Share%20on%20twitter&style=social" target="_blank" />
+  </a>
+</p>
+
 ## Introduction
 
 FastAdmin is an easy-to-use Admin App for FastAPI inspired by Django Admin.
@@ -158,122 +164,17 @@ class GroupAdmin(TortoiseModelAdmin):
 
 #### Run your project
 
-Run your project (see https://fastapi.tiangolo.com/tutorial/first-steps/):
+Run your project (see [https://fastapi.tiangolo.com/tutorial/first-steps/](https://fastapi.tiangolo.com/tutorial/first-steps/)):
 
 ```bash
 uvicorn ...
 ```
 
-Go to http://localhost:8000/admin
-
-## Configuration
-
-You can find all env variables to configure FastAdmin [here](https://github.com/vsdudakov/fastadmin/blob/main/fastadmin/settings.py)
-
-You can find all parameters and methods to configure your ModelAdmin classes [here](https://github.com/vsdudakov/fastadmin/blob/main/fastadmin/models/base.py)
-
-Example:
-
-```python
-from fastadmin import TortoiseModelAdmin, register, action, display
-
-@register(User)
-class UserAdmin(TortoiseModelAdmin):
-    label_fields = ("email", "id")
-    exclude = ("hash_password",)
-    list_display = ("id", "email", "has_hash_password", "is_superuser", "is_active")
-    list_display_links = ("id",)
-    list_filter = ("id", "email", "is_superuser")
-    search_fields = ("email",)
-    actions = ("set_as_active",)
+Go to [http://localhost:8000/admin](http://localhost:8000/admin).
 
-    def has_delete_permission(self) -> bool:
-        return False
+## Documentation
 
-    @action(description="Set as active")
-    async def set_as_active(self, ids: list[int | UUID]) -> None:
-        await User.filter(id__in=ids).update(is_active=True)
-
-    @display
-    async def has_hash_password(self, obj: Any) -> Any:
-        return obj.hash_password is not None
-
-    ...
-```
-
-## Other ORMs or own implementation
-
-We are going to support SQLAlchemy and Pony ORM soon...
-
-If you have smth else (your own implementation of ORM and so on) you will may overload ModelAdmin class and implement the following interfaces
-
-```python
-from typing import Any
-from collections import OrderedDict
-from fastadmin import ModelAdmin, WidgetType
-
-class MyModelAdmin(ModelAdmin):
-    async def save_model(self, id: UUID | int | None, payload: dict) -> dict | None:
-        """This method is used to save orm/db model object.
-
-        :params id: an id of object.
-        :params payload: a payload from request.
-        :return: A saved object or None.
-        """
-        raise NotImplementedError
-
-    async def delete_model(self, id: UUID | int) -> None:
-        """This method is used to delete orm/db model object.
-
-        :params id: an id of object.
-        :return: None.
-        """
-        raise NotImplementedError
-
-    async def get_obj(self, id: UUID | int) -> dict | None:
-        """This method is used to get orm/db model object by id.
-
-        :params id: an id of object.
-        :return: An object or None.
-        """
-        raise NotImplementedError
-
-    async def get_list(
-        self,
-        offset: int | None = None,
-        limit: int | None = None,
-        search: str | None = None,
-        sort_by: str | None = None,
-        filters: dict | None = None,
-    ) -> tuple[list[dict], int]:
-        """This method is used to get list of orm/db model objects.
-
-        :params offset: an offset for pagination.
-        :params limit: a limit for pagination.
-        :params search: a search query.
-        :params sort_by: a sort by field name.
-        :params filters: a dict of filters.
-        :return: A tuple of list of objects and total count.
-        """
-        raise NotImplementedError
-
-    def get_model_fields(self) -> OrderedDict[str, dict]:
-        """This method is used to get all orm/db model fields
-        with saving ordering (non relations, fk, o2o, m2m).
-
-        :return: An OrderedDict of model fields.
-        """
-        raise NotImplementedError
-
-    def get_form_widget(self, field_name: str) -> tuple[WidgetType, dict]:
-        """This method is used to get form item widget
-        for field from orm/db model.
-
-        :params field_name: a model field name.
-        :return: A tuple of widget type and widget props.
-        """
-        raise NotImplementedError
-```
+See full documentation [here](https://vsdudakov.github.io/fastadmin/).
 
 ## License
 

{fastadmin-0.1.15 → fastadmin-0.1.17}/README.md

@@ -12,6 +12,12 @@
 ![List View](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/images/list.png)
 ![Change View](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/images/change.png)
 
+<p align="center">
+  <a href="https://twitter.com/intent/tweet?text=Admin%20Dashboard%20For%20FastAPI&url=https://github.com/vsdudakov/fastadmin&hashtags=FastAPI,AdminDashboard">
+    <img alt="tweet" src="https://img.shields.io/twitter/url/https/twitter?label=Share%20on%20twitter&style=social" target="_blank" />
+  </a>
+</p>
+
 ## Introduction
 
 FastAdmin is an easy-to-use Admin App for FastAPI inspired by Django Admin.
@@ -131,122 +137,17 @@ class GroupAdmin(TortoiseModelAdmin):
 
 #### Run your project
 
-Run your project (see https://fastapi.tiangolo.com/tutorial/first-steps/):
+Run your project (see [https://fastapi.tiangolo.com/tutorial/first-steps/](https://fastapi.tiangolo.com/tutorial/first-steps/)):
 
 ```bash
 uvicorn ...
 ```
 
-Go to http://localhost:8000/admin
-
-## Configuration
-
-You can find all env variables to configure FastAdmin [here](https://github.com/vsdudakov/fastadmin/blob/main/fastadmin/settings.py)
-
-You can find all parameters and methods to configure your ModelAdmin classes [here](https://github.com/vsdudakov/fastadmin/blob/main/fastadmin/models/base.py)
-
-Example:
-
-```python
-from fastadmin import TortoiseModelAdmin, register, action, display
-
-@register(User)
-class UserAdmin(TortoiseModelAdmin):
-    label_fields = ("email", "id")
-    exclude = ("hash_password",)
-    list_display = ("id", "email", "has_hash_password", "is_superuser", "is_active")
-    list_display_links = ("id",)
-    list_filter = ("id", "email", "is_superuser")
-    search_fields = ("email",)
-    actions = ("set_as_active",)
+Go to [http://localhost:8000/admin](http://localhost:8000/admin).
 
-    def has_delete_permission(self) -> bool:
-        return False
+## Documentation
 
-    @action(description="Set as active")
-    async def set_as_active(self, ids: list[int | UUID]) -> None:
-        await User.filter(id__in=ids).update(is_active=True)
-
-    @display
-    async def has_hash_password(self, obj: Any) -> Any:
-        return obj.hash_password is not None
-
-    ...
-```
-
-## Other ORMs or own implementation
-
-We are going to support SQLAlchemy and Pony ORM soon...
-
-If you have smth else (your own implementation of ORM and so on) you will may overload ModelAdmin class and implement the following interfaces
-
-```python
-from typing import Any
-from collections import OrderedDict
-from fastadmin import ModelAdmin, WidgetType
-
-class MyModelAdmin(ModelAdmin):
-    async def save_model(self, id: UUID | int | None, payload: dict) -> dict | None:
-        """This method is used to save orm/db model object.
-
-        :params id: an id of object.
-        :params payload: a payload from request.
-        :return: A saved object or None.
-        """
-        raise NotImplementedError
-
-    async def delete_model(self, id: UUID | int) -> None:
-        """This method is used to delete orm/db model object.
-
-        :params id: an id of object.
-        :return: None.
-        """
-        raise NotImplementedError
-
-    async def get_obj(self, id: UUID | int) -> dict | None:
-        """This method is used to get orm/db model object by id.
-
-        :params id: an id of object.
-        :return: An object or None.
-        """
-        raise NotImplementedError
-
-    async def get_list(
-        self,
-        offset: int | None = None,
-        limit: int | None = None,
-        search: str | None = None,
-        sort_by: str | None = None,
-        filters: dict | None = None,
-    ) -> tuple[list[dict], int]:
-        """This method is used to get list of orm/db model objects.
-
-        :params offset: an offset for pagination.
-        :params limit: a limit for pagination.
-        :params search: a search query.
-        :params sort_by: a sort by field name.
-        :params filters: a dict of filters.
-        :return: A tuple of list of objects and total count.
-        """
-        raise NotImplementedError
-
-    def get_model_fields(self) -> OrderedDict[str, dict]:
-        """This method is used to get all orm/db model fields
-        with saving ordering (non relations, fk, o2o, m2m).
-
-        :return: An OrderedDict of model fields.
-        """
-        raise NotImplementedError
-
-    def get_form_widget(self, field_name: str) -> tuple[WidgetType, dict]:
-        """This method is used to get form item widget
-        for field from orm/db model.
-
-        :params field_name: a model field name.
-        :return: A tuple of widget type and widget props.
-        """
-        raise NotImplementedError
-```
+See full documentation [here](https://vsdudakov.github.io/fastadmin/).
 
 ## License
 

{fastadmin-0.1.15 → fastadmin-0.1.17}/fastadmin/api/api.py

@@ -370,7 +370,7 @@ async def configuration(
                 ),
             )
 
-        for field_name in admin_obj.list_display:
+        for column_index, field_name in enumerate(admin_obj.list_display):
             display_field_function = getattr(admin_obj, field_name, None)
             if (
                 not display_field_function
@@ -379,15 +379,12 @@ async def configuration(
             ):
                 continue
 
-            column_index = admin_obj.list_display.index(field_name) if field_name in admin_obj.list_display else None
-            if column_index is None:
-                continue
             fields_schema.append(
                 ModelFieldSchema(
                     name=field_name,
                     list_configuration=ListConfigurationFieldSchema(
                         index=column_index,
-                        sorter=None,
+                        sorter=False,
                         is_link=field_name in admin_obj.list_display_links,
                         empty_value_display=admin_obj.empty_value_display,
                         filter_widget_type=None,
@@ -433,6 +430,7 @@ async def configuration(
                 actions_on_bottom=admin_obj.actions_on_bottom,
                 actions_selection_counter=admin_obj.actions_selection_counter,
                 fields=fields_schema,
+                fieldsets=admin_obj.fieldsets,
                 list_per_page=admin_obj.list_per_page,
                 save_on_top=admin_obj.save_on_top,
                 save_as=admin_obj.save_as,

{fastadmin-0.1.15 → fastadmin-0.1.17}/fastadmin/models/base.py

@@ -420,18 +420,21 @@ class BaseModelAdmin:
 
         :return: A list of model field names.
         """
-        fields = self.fields
         model_fields = self.get_model_fields()
-        if not fields:
-            return [f for f in model_fields if not self.exclude or f not in self.exclude]
-        return [f for f in fields if f in model_fields]
 
-    # def get_fieldsets(self) -> Sequence[tuple[str | None, dict[str, Sequence[str]]]]:
-    #     """This method is used to get fieldsets data for form view.
-
-    #     :return: A list of fieldsets data.
-    #     """
-    #     return self.fieldsets
+        fields = [f for f in model_fields if model_fields[f].get("is_pk")]
+        if not self.fields:
+            if self.fieldsets:
+                for item in self.fieldsets:
+                    for field in item[1].get("fields") or []:
+                        if field not in fields and field not in self.exclude:
+                            fields.append(field)
+            else:
+                for field in model_fields:
+                    if field not in fields and field not in self.exclude:
+                        fields.append(field)
+
+        return fields
 
     def has_add_permission(self) -> bool:
         """This method is used to check if user has permission to add new model instance.

{fastadmin-0.1.15 → fastadmin-0.1.17}/fastadmin/models/orm/tortoise.py

@@ -247,7 +247,7 @@ class TortoiseModelAdmin(BaseModelAdmin):
         widget_props = {
             "required": field.get("required") or False,
             "disabled": field_name in self.readonly_fields,
-            "readonly": field_name in self.readonly_fields,
+            "readOnly": field_name in self.readonly_fields,
         }
         match field.get("orm_class_name"):
             case "CharField":

{fastadmin-0.1.15 → fastadmin-0.1.17}/fastadmin/schemas/configuration.py

@@ -92,6 +92,7 @@ class ModelSchema(BaseModel):
     actions_on_bottom: bool | None
     actions_selection_counter: bool | None
     fields: Sequence[ModelFieldSchema]
+    fieldsets: Sequence[tuple[str | None, dict[str, Sequence[str]]]] | None
     list_per_page: int | None
     save_on_top: bool | None
     save_as: bool | None