fastadmin 0.1.15__py3-none-any.whl → 0.1.17__py3-none-any.whl

{fastadmin-0.1.15.dist-info → fastadmin-0.1.17.dist-info}/METADATA

@@ -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.dist-info → fastadmin-0.1.17.dist-info}/RECORD

@@ -1,19 +1,19 @@
 LICENSE,sha256=-5Cmq6xd5DlFq8rhBcqGMi8Mlh_h-YVjKOYjnYk5dyM,1063
 fastadmin/__init__.py,sha256=sLDFNirUYkuv-VYh6fPFs8tQfU6puC8hN0Al0UcI8WM,310
 fastadmin/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastadmin/api/api.py,sha256=R5ZPGJkBbdZai2c6Oh5QFdww2YwgnjizS-7ChuSamsc,16062
+fastadmin/api/api.py,sha256=5Hp5I4BYje-Hb-Yx4SWKmYb3X3eq1B4dg7wlfo6gxsk,15955
 fastadmin/api/depends.py,sha256=d73Ufqho51fXyzp9zNYOdOItNMU_Q8wifLTLR4FqSJ4,1518
 fastadmin/api/helpers.py,sha256=SJ0peUtrKsmEzCu0Z0KHJAUeI7AJs5Fwloda29jz0sg,293
 fastadmin/app.py,sha256=MsuLf6bCO82IpsHv10K-fdlZJ-UTLOuFq9-NuKHXdIw,659
 fastadmin/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastadmin/models/base.py,sha256=mFqhlERU99FVgvOxFOi360qF8rZfqHkLuq1vi3bO90s,20832
+fastadmin/models/base.py,sha256=LeYldh_b9H52aVZSlj6UpTgyg_XKf9R9KXvdXYoaUa0,20954
 fastadmin/models/decorators.py,sha256=X3WYb1DRk0OQBM4CHPQpcVmlioQpQkBOg7svPXijxpM,1952
 fastadmin/models/helpers.py,sha256=ipqzOfJlI0CUH9iX1Gtdy2Kaes8Jihx7JY9S7X6J7hI,1558
 fastadmin/models/orm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastadmin/models/orm/tortoise.py,sha256=RvDWC6NRHIc8wLKa1YZ_Rg02L2SJa8MOVk17jgxq51Y,13920
+fastadmin/models/orm/tortoise.py,sha256=_VSUaEUt-I-m8D7H1kMlVLlLjXJkH-Sbpc_tvuyPQPQ,13920
 fastadmin/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fastadmin/schemas/api.py,sha256=mDHV0Hb4cBSEIVsCLcVoaCxbse3zfJrie57IrBmiZPw,475
-fastadmin/schemas/configuration.py,sha256=vTWgBeWCciF1iX2YbqeAxcwRzBohRpoLfE16d7_RbP8,2712
+fastadmin/schemas/configuration.py,sha256=7N8pQ6vdN18fmM5gxJdvGkJBUwrfYw5u3d0LtpHxmEI,2788
 fastadmin/settings.py,sha256=K8G9oXYD2sNs-VHIP7PQQNOqmD2hq-MWWD1M65hIDDA,863
 fastadmin/static/css/main.min.css,sha256=ywdS7o8G1nCGvmQ6Pcf2oOW6UEclxgyWyrT7-VYetVw,338
 fastadmin/static/css/main.min.css.map,sha256=N1fWreIFJPEjGjYLYrC7BH60GRQiIntkIFrEfThBMD4,577
@@ -22,11 +22,11 @@ fastadmin/static/images/header-logo.svg,sha256=FfFOShL7p4EvggDS106VDcMzI_Oe7zAG7
 fastadmin/static/images/sign-in-logo.svg,sha256=sD6YXIwT0kOvZTCGxyoUMiIoszXV77OBxFLvlZOYEeE,1359
 fastadmin/static/js/787.cda612ba.chunk.js,sha256=-RCoc7bpkR5Qc6h9hEIbw6X_JUO_cv37kwW5dVF5Puk,4598
 fastadmin/static/js/787.cda612ba.chunk.js.map,sha256=q92gAWgbcGnaqv7QywNICs53249Z6Z9oybAwQCojZCk,10593
-fastadmin/static/js/main.min.js,sha256=n7o_AnIdkqm4W9VLHW4z2BYVTcBYLSnhcL7SRk3Pkq8,1364769
-fastadmin/static/js/main.min.js.map,sha256=UD1IAAu-T_EiTs5O4bx5o2W4gmRVy08kiO8HNZQ-S70,5560730
+fastadmin/static/js/main.min.js,sha256=5hSo50uN-fea9OdhpcRJh7hFGgMk6d5DD4WroYeESd0,1375297
+fastadmin/static/js/main.min.js.map,sha256=cX46ZH17nRnRj6U3lb9RPgh-ajQJ_K1c85T6_SOynf8,5601821
 fastadmin/templates/index.html,sha256=QKlszqiykreOqpgJTlym78fzBClL3W9Q6v8QkLVBZgQ,749
 fastadmin/views.py,sha256=jQvg4wwkEv4SJob5Z0duP-O7N0b3cpPEMDcKb3KG2MA,698
-fastadmin-0.1.15.dist-info/LICENSE,sha256=-5Cmq6xd5DlFq8rhBcqGMi8Mlh_h-YVjKOYjnYk5dyM,1063
-fastadmin-0.1.15.dist-info/METADATA,sha256=IsmnacGt-UlnebqLih7OBQirH53WpddfN1aL_mUXWKI,8720
-fastadmin-0.1.15.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
-fastadmin-0.1.15.dist-info/RECORD,,
+fastadmin-0.1.17.dist-info/LICENSE,sha256=-5Cmq6xd5DlFq8rhBcqGMi8Mlh_h-YVjKOYjnYk5dyM,1063
+fastadmin-0.1.17.dist-info/METADATA,sha256=20luf3UFlvhTNEOrH3Z2dPbUZqoyGz0n_tYNyonjPVw,5670
+fastadmin-0.1.17.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
+fastadmin-0.1.17.dist-info/RECORD,,