Rename fastapi_admin.models.User to fastapi_admin.models.AbstractUser.

CHANGELOG.rst

@@ -5,6 +5,10 @@ ChangeLog
 0.2
 ===
 
+0.2.9
+-----
+- Rename `fastapi_admin.models.User` to `fastapi_admin.models.AbstractUser`.
+
 0.2.8
 -----
 - Add password auto hash.

README.md

@@ -112,13 +112,13 @@ for reference.
 
 ### Builtin Auth And Permissions Control
 
-Inherit `fastapi_admin.models.User` and add you own fields,must contains
+You should inherit `fastapi_admin.models.AbstractUser` and add you own fields,must contains
 `is_active` and `is_superuser`.
 
 ```python
-from fastapi_admin.models import User as AdminUser
+from fastapi_admin.models import AbstractUser
 
-class AdminUser(AdminUser,Model):
+class AdminUser(AbstractUser,Model):
     is_active = fields.BooleanField(default=False, description='Is Active')
     is_superuser = fields.BooleanField(default=False, description='Is Superuser')
     status = fields.IntEnumField(Status, description='User Status')

examples/models.py

@@ -2,12 +2,12 @@ import datetime
 
 from tortoise import Model, fields
 
-from fastapi_admin.models import User as AdminUser
+from fastapi_admin.models import AbstractUser
 
 from .enums import ProductType, Status
 
 
-class User(AdminUser):
+class User(AbstractUser):
     last_login = fields.DatetimeField(description="Last Login", default=datetime.datetime.now)
     is_active = fields.BooleanField(default=True, description="Is Active")
     is_superuser = fields.BooleanField(default=False, description="Is SuperUser")

fastapi_admin/__init__.py

@@ -5,4 +5,4 @@ def version():
     # with open("pyproject.toml") as f:
     #     ret = re.findall(r'version = "(\d+\.\d+\.\d+)"', f.read())
     #     return ret[0]
-    return "0.2.8"
+    return "0.2.9"

fastapi_admin/models.py

@@ -3,7 +3,7 @@ from tortoise import Model, fields
 from fastapi_admin import enums
 
 
-class User(Model):
+class AbstractUser(Model):
     username = fields.CharField(max_length=20, unique=True)
     password = fields.CharField(max_length=200, description="Will auto hash with raw password")
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fastapi-admin"
-version = "0.2.8"
+version = "0.2.9"
 description = "Fast Admin Dashboard based on fastapi and tortoise-orm and rest-admin."
 authors = ["long2ice <long2ice@gmail.com>"]
 license = "Apache-2.0"