fastadmin 0.2.21__tar.gz → 0.3.0__tar.gz

{fastadmin-0.2.21 → fastadmin-0.3.0}/PKG-INFO

@@ -1,12 +1,13 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: fastadmin
-Version: 0.2.21
+Version: 0.3.0
 Summary: FastAdmin is an easy-to-use Admin Dashboard App for FastAPI/Flask/Django inspired by Django Admin.
 License: MIT
+License-File: LICENSE
 Keywords: fastapi,admin
 Author: Seva D
 Author-email: vsdudakov@gmail.com
-Requires-Python: >=3.10,<4.0
+Requires-Python: >=3.12,<4.0
 Classifier: Environment :: Console
 Classifier: Framework :: Django
 Classifier: Framework :: FastAPI
@@ -14,10 +15,9 @@ Classifier: Framework :: Flask
 Classifier: License :: OSI Approved :: MIT License
 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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Widget Sets
@@ -27,32 +27,32 @@ Provides-Extra: flask
 Provides-Extra: pony
 Provides-Extra: sqlalchemy
 Provides-Extra: tortoise-orm
-Requires-Dist: asgiref (>=3.7.0,<4.0.0)
-Requires-Dist: django (==5.*) ; extra == "django"
+Requires-Dist: asgiref (>=3.11.1,<4.0.0)
+Requires-Dist: django (==6.*) ; extra == "django"
 Requires-Dist: fastapi (==0.*) ; extra == "fastapi"
 Requires-Dist: flask (==3.*) ; extra == "flask"
+Requires-Dist: greenlet (>=3.0,<4.0) ; extra == "sqlalchemy"
 Requires-Dist: pony (==0.*) ; extra == "pony"
 Requires-Dist: pyjwt (>=2.6.0,<3.0.0)
 Requires-Dist: sqlalchemy[asyncio] (==2.*) ; extra == "sqlalchemy"
-Requires-Dist: tortoise-orm (==0.*) ; extra == "tortoise-orm"
+Requires-Dist: tortoise-orm (==1.*) ; extra == "tortoise-orm"
 Project-URL: Homepage, https://github.com/vsdudakov/fastadmin
 Project-URL: Repository, https://github.com/vsdudakov/fastadmin
 Description-Content-Type: text/markdown
 
-## Admin Dashboard App for FastAPI/Flask/Django
+# Admin Dashboard for FastAPI / Flask / Django
 
 [![codecov](https://codecov.io/gh/vsdudakov/fastadmin/branch/main/graph/badge.svg?token=RNGX5HOW3T)](https://codecov.io/gh/vsdudakov/fastadmin)
 [![License](https://img.shields.io/github/license/vsdudakov/fastadmin)](https://github.com/vsdudakov/fastadmin/blob/master/LICENSE)
 [![PyPi](https://badgen.net/pypi/v/fastadmin)](https://pypi.org/project/fastadmin/)
-[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
-[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/)
 [![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3120/)
+[![Python 3.13](https://img.shields.io/badge/python-3.13-blue.svg)](https://www.python.org/downloads/release/python-3130/)
 
 ## Screenshots
 
-![SignIn View](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/images/signin.png)
-![List View](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/images/list.png)
-![Change View](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/images/change.png)
+![Sign-in view](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/images/signin.png)
+![List view](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/images/list.png)
+![Change view](https://raw.githubusercontent.com/vsdudakov/fastadmin/main/docs/assets/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">
@@ -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.
+<a href='https://github.com/vsdudakov/fastadmin' target='_blank'>FastAdmin</a> is an easy-to-use admin dashboard for FastAPI, Django, and 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.
+FastAdmin is built with relationships in mind and admiration for Django Admin. Its design focuses on making it as easy as possible to configure your admin dashboard for FastAPI, Django, or Flask.
 
 
 
@@ -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.
+FastAdmin aims to be minimal, functional, and familiar.
 
 
 
@@ -123,7 +123,7 @@ FastAdmin is designed to be minimalistic, functional and yet familiar.
 
 
 
-If you have any questions that are beyond the scope of the documentation, Please feel free to email <a href='mailto:vsdudakov@gmail.com' target='_blank'>us</a>.
+If you have questions beyond this documentation, feel free to <a href='mailto:vsdudakov@gmail.com' target='_blank'>email us</a>.
 
 
 
@@ -141,7 +141,7 @@ If you have any questions that are beyond the scope of the documentation, Please
   
 
 
-Follow the steps below to setup FastAdmin:
+Follow the steps below to set up FastAdmin:
 
 
 
@@ -155,7 +155,7 @@ Follow the steps below to setup FastAdmin:
 
 
   
-Install the package using pip:
+Install the package with pip:
 
 
 
@@ -175,7 +175,7 @@ Install the package using pip:
 
 
 
-Note: For zsh and macos use: <code>pip install fastadmin[fastapi,django]</code>
+On zsh and macOS, use quotes: <code>pip install 'fastadmin[fastapi,django]'</code>
 
 
 
@@ -197,13 +197,13 @@ Note: For zsh and macos use: <code>pip install fastadmin[fastapi,django]</code>
 
 ```bash
 
-pip install fastadmin[fastapi,django]  # for fastapi with django orm
-pip install fastadmin[fastapi,tortoise-orm]  # for fastapi with tortoise orm
-pip install fastadmin[fastapi,pony]  # for fastapi with pony orm
-pip install fastadmin[fastapi,sqlalchemy]  # for fastapi with sqlalchemy orm
-pip install fastadmin[django]  # for django with django orm
-pip install fastadmin[django,pony]  # for django with pony orm
-pip install fastadmin[flask,sqlalchemy]  # for flask with sqlalchemy
+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)
 
 ```
 
@@ -213,7 +213,7 @@ pip install fastadmin[flask,sqlalchemy]  # for flask with sqlalchemy
 
 
   
-Install the package using poetry:
+Or install with Poetry:
 
 
 
@@ -239,13 +239,13 @@ Install the package using poetry:
 
 ```bash
 
-poetry add 'fastadmin[fastapi,django]'  # for fastapi with django orm
-poetry add 'fastadmin[fastapi,tortoise-orm]'  # for fastapi with tortoise orm
-poetry add 'fastadmin[fastapi,pony]'  # for fastapi with pony orm
-poetry add 'fastadmin[fastapi,sqlalchemy]'  # for fastapi with sqlalchemy orm
-poetry add 'fastadmin[django]'  # for django with django orm
-poetry add 'fastadmin[django,pony]'  # for django with pony orm
-poetry add 'fastadmin[flask,sqlalchemy]'  # for flask with sqlalchemy
+poetry add 'fastadmin[fastapi,django]'
+poetry add 'fastadmin[fastapi,tortoise-orm]'
+poetry add 'fastadmin[fastapi,pony]'
+poetry add 'fastadmin[fastapi,sqlalchemy]'
+poetry add 'fastadmin[django]'
+poetry add 'fastadmin[django,pony]'
+poetry add 'fastadmin[flask,sqlalchemy]'
 
 ```
 
@@ -255,11 +255,11 @@ poetry add 'fastadmin[flask,sqlalchemy]'  # for flask with sqlalchemy
 
 
   
-Configure required settings using virtual environment variables:
 
 
 
 
+When using SQLAlchemy, the <code>greenlet</code> package is required (included in the <code>fastadmin[sqlalchemy]</code> extra).
 
 
 
@@ -271,11 +271,27 @@ Configure required settings using virtual environment variables:
 
 
   
+Configure the required settings with environment variables:
 
 
 
 
-Note: You can add these variables to .env and use python-dotenv to load them. See all settings <a href='https://vsdudakov.github.io/fastadmin#settings'>here</a>
+
+
+
+
+
+
+
+
+
+
+  
+
+
+
+
+You can add these variables to a <code>.env</code> file and load them with python-dotenv. See <a href='https://vsdudakov.github.io/fastadmin#settings'>all settings</a> in the full documentation.
 
 
 
@@ -314,7 +330,7 @@ export ADMIN_SECRET_KEY=secret_key
   
 
 
-Setup FastAdmin for a framework
+Set up FastAdmin for your framework
 
 
 
@@ -475,13 +491,14 @@ Register ORM models
 
 
 ```python
+import typing as tp
 from uuid import UUID
 
 import bcrypt
 from tortoise import fields
 from tortoise.models import Model
 
-from fastadmin import TortoiseModelAdmin, register
+from fastadmin import TortoiseModelAdmin, WidgetType, register
 
 
 class User(Model):
@@ -489,6 +506,7 @@ class User(Model):
     hash_password = fields.CharField(max_length=255)
     is_superuser = fields.BooleanField(default=False)
     is_active = fields.BooleanField(default=False)
+    avatar_url = fields.TextField(null=True)
 
     def __str__(self):
         return self.username
@@ -501,15 +519,39 @@ class UserAdmin(TortoiseModelAdmin):
     list_display_links = ("id", "username")
     list_filter = ("id", "username", "is_superuser", "is_active")
     search_fields = ("username",)
-
-    async def authenticate(self, username: str, password: str) -> UUID | int | None:
-        user = await User.filter(username=username, is_superuser=True).first()
+    formfield_overrides = {  # noqa: RUF012
+        "username": (WidgetType.SlugInput, {"required": True}),
+        "password": (WidgetType.PasswordInput, {"passwordModalForm": True}),
+        "avatar_url": (
+            WidgetType.Upload,
+            {
+                "required": False,
+                # Disable crop image for upload field
+                # "disableCropImage": True,
+            },
+        ),
+    }
+
+    async def authenticate(self, username: str, password: str) -> int | None:
+        user = await self.model_cls.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: UUID | int | str, password: str) -> None:
+        user = await self.model_cls.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",))
+
+    async def orm_save_upload_field(self, obj: tp.Any, field: str, base64: str) -> None:
+        # convert base64 to bytes, upload to s3/filestorage, get url and save or save base64 as is to db (don't recomment it)
+        setattr(obj, field, base64)
+        await obj.save(update_fields=(field,))
+
 ```
 
 
@@ -569,7 +611,7 @@ class UserAdmin(DjangoModelAdmin):
 
 
 
-### SQL Alchemy
+### SQLAlchemy
 
 
 
@@ -583,8 +625,11 @@ class UserAdmin(DjangoModelAdmin):
 
 
 ```python
+import typing as tp
+import uuid
+
 import bcrypt
-from sqlalchemy import Boolean, Integer, String, select
+from sqlalchemy import Boolean, Integer, String, Text, select, update
 from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine
 from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
 
@@ -609,6 +654,7 @@ class User(Base):
     hash_password: Mapped[str] = mapped_column(String(length=255), nullable=False)
     is_superuser: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
     is_active: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
+    avatar_url: Mapped[str | None] = mapped_column(Text, nullable=True)
 
     def __str__(self):
         return self.username
@@ -622,17 +668,33 @@ class UserAdmin(SqlAlchemyModelAdmin):
     list_filter = ("id", "username", "is_superuser", "is_active")
     search_fields = ("username",)
 
-    async def authenticate(self, username, password):
+    async def authenticate(self, username: str, password: str) -> uuid.UUID | int | None:
         sessionmaker = self.get_sessionmaker()
         async with sessionmaker() as session:
-            query = select(User).filter_by(username=username, password=password, is_superuser=True)
+            query = select(self.model_cls).filter_by(username=username, password=password, is_superuser=True)
             result = await session.scalars(query)
-            user = result.first()
-            if not user:
+            obj = result.first()
+            if not obj:
                 return None
-            if not bcrypt.checkpw(password.encode(), user.hash_password.encode()):
+            if not bcrypt.checkpw(password.encode(), obj.hash_password.encode()):
                 return None
-            return user.id
+            return obj.id
+
+    async def change_password(self, id: uuid.UUID | int | str, password: str) -> None:
+        sessionmaker = self.get_sessionmaker()
+        async with sessionmaker() as session:
+            hash_password = bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
+            query = update(self.model_cls).where(User.id.in_([id])).values(hash_password=hash_password)
+            await session.execute(query)
+            await session.commit()
+
+    async def orm_save_upload_field(self, obj: tp.Any, field: str, base64: str) -> None:
+        sessionmaker = self.get_sessionmaker()
+        async with sessionmaker() as session:
+            # convert base64 to bytes, upload to s3/filestorage, get url and save or save base64 as is to db (don't recomment it)
+            query = update(self.model_cls).where(User.id.in_([obj.id])).values(**{field: base64})
+            await session.execute(query)
+            await session.commit()
 
 ```
 
@@ -655,8 +717,11 @@ class UserAdmin(SqlAlchemyModelAdmin):
 
 
 ```python
+import typing as tp
+import uuid
+
 import bcrypt
-from pony.orm import Database, PrimaryKey, Required, db_session
+from pony.orm import Database, LongStr, Optional, PrimaryKey, Required, commit, db_session
 
 from fastadmin import PonyORMModelAdmin, register
 
@@ -671,6 +736,7 @@ class User(db.Entity):  # type: ignore [name-defined]
     hash_password = Required(str)
     is_superuser = Required(bool, default=False)
     is_active = Required(bool, default=False)
+    avatar_url = Optional(LongStr, nullable=True)
 
     def __str__(self):
         return self.username
@@ -685,13 +751,31 @@ class UserAdmin(PonyORMModelAdmin):
     search_fields = ("username",)
 
     @db_session
-    def authenticate(self, username, password):
-        user = next((f for f in self.model_cls.select(username=username, password=password, is_superuser=True)), None)
-        if not user:
+    def authenticate(self, username: str, password: str) -> uuid.UUID | int | None:
+        obj = next((f for f in User.select(username=username, password=password, is_superuser=True)), None)  # fmt: skip
+        if not obj:
             return None
-        if not bcrypt.checkpw(password.encode(), user.hash_password.encode()):
+        if not bcrypt.checkpw(password.encode(), obj.hash_password.encode()):
             return None
-        return user.id
+        return obj.id
+
+    @db_session
+    def change_password(self, id: uuid.UUID | int, password: str) -> None:
+        obj = next((f for f in self.model_cls.select(id=id)), None)
+        if not obj:
+            return
+        hash_password = bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
+        obj.hash_password = hash_password
+        commit()
+
+    @db_session
+    def orm_save_upload_field(self, obj: tp.Any, field: str, base64: str) -> None:
+        obj = next((f for f in self.model_cls.select(id=obj.id)), None)
+        if not obj:
+            return
+        # convert base64 to bytes, upload to s3/filestorage, get url and save or save base64 as is to db (don't recomment it)
+        setattr(obj, field, base64)
+        commit()
 
 ```
 
@@ -717,7 +801,9 @@ class UserAdmin(PonyORMModelAdmin):
 
 
 ## Documentation
-See full documentation [here](https://vsdudakov.github.io/fastadmin).
+
+Full documentation is available at [vsdudakov.github.io/fastadmin](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.