Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
FastAPI-Admin is a admin dashboard based on fastapi and tortoise-orm.
FastAPI-Admin provide crud feature out-of-the-box with just a few config.
Check a live Demo here https://fastapi-admin.long2ice.cn.
- username: admin
- password: 123456
Data in database will restore every day.
- FastAPI framework as your backend framework.
- Tortoise-ORM as your orm framework, by the way, which is best asyncio orm so far and I'm one of the contributors😋.
Look full example at examples.
- git clone https://github.com/long2ice/fastapi-admin.git.
- docker-compose up -d --build.
- docker-compose exec -T mysql mysql -uroot -p123456 < examples/example.sql fastapi-admin.
- That's just all, api server is listen at http://127.0.0.1:8000 now.
See restful-admin for reference.
> pip3 install fastapi-adminfrom fastapi_admin.factory import app as admin_app
fast_app = FastAPI()
register_tortoise(fast_app, config=TORTOISE_ORM, generate_schemas=True)
fast_app.mount('/admin', admin_app)
@fast_app.on_event('startup')
async def startup():
await admin_app.init(
admin_secret="test",
permission=True,
site=Site(
name="FastAPI-Admin DEMO",
login_footer="FASTAPI ADMIN - FastAPI Admin Dashboard",
login_description="FastAPI Admin Dashboard",
locale="en-US",
locale_switcher=True,
theme_switcher=True,
),
)You should inherit fastapi_admin.models.AbstractUser,fastapi_admin.models.AbstractPermission,fastapi_admin.models.AbstractRole and add extra fields.
from fastapi_admin.models import AbstractUser,AbstractPermission,AbstractRole
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')
created_at = fields.DatetimeField(auto_now_add=True)
updated_at = fields.DatetimeField(auto_now=True)
class Permission(AbstractPermission):
pass
class Role(AbstractRole):
passAnd set permission=True to active it:
await admin_app.init(
...
permission=True,
site=Site(
...
),
)And createsuperuser:
> fastapi-admin -h
usage: fastapi-admin [-h] -c CONFIG [--version] {createsuperuser} ...
optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
Tortoise-orm config dict import path,like settings.TORTOISE_ORM.
--version, -V show the version
subcommands:
{createsuperuser}You can write your own login view logic:
await admin_app.init(
...
login_view="examples.routes.login"
)And must return json like:
{
"user": {
"username": "admin",
"is_superuser": false,
"avatar": "https://avatars2.githubusercontent.com/u/13377178?s=460&u=d150d522579f41a52a0b3dd8ea997e0161313b6e&v=4"
},
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyfQ.HSlcYkOEQewxyPuaqcVwCcw_wkbLB50Ws1-ZxfPoLAQ"
}When you define a enum field of tortoise-orm,like IntEnumField,you can inherit fastapi_admin.enums.EnumMixin and impl choices() method, FastAPI-Admin will auto read and display and render a select widget in front.
class Status(EnumMixin, IntEnum):
on = 1
off = 2
@classmethod
def choices(cls):
return {
cls.on: 'ON',
cls.off: 'OFF'
}FastAPI-Admin will auto read description defined in tortoise-orm model Field and display in front with form help text.
If ForeignKeyField not passed in menu.raw_id_fields,FastAPI-Admin will get all related objects and display select in front with Model.__str__.
FastAPI-Admin will render ManyToManyField with multiple select in form edit with Model.__str__.
FastAPI-Admin will render JSONField with jsoneditor as beauty interface.
Defined menu.search_fields in menu will render a search form by fields.
FastAPI-Admin can export searched data to excel file when define export=True in menu.
Current FastAPI-Admin support builtin bulk action delete_all,if you want write your own bulk actions:
- pass bulk_actions in Menu,example:
Menu(
...
bulk_actions=[{
'value': 'delete', # this is fastapi router path param.
'text': 'delete_all', # this will show in front.
}]
)- write fastapi route,example:
from fastapi_admin.schemas import BulkIn
from fastapi_admin.factory import app as admin_app
@admin_app.post(
'/rest/{resource}/bulk/delete' # `delete` is defined in Menu before.
)
async def bulk_delete(
bulk_in: BulkIn,
model=Depends(get_model)
):
await model.filter(pk__in=bulk_in.pk_list).delete()
return {'success': True}Default, FastAPI-Admin provide default menus by your models, without doing tedious works.
You can define RowVariant and CellVariants in computed of tortoise-orm, which will effect table rows and cells variant.
class User(AbstractUser):
last_login = fields.DatetimeField(description="Last Login", default=datetime.datetime.now)
avatar = fields.CharField(max_length=200, default="")
intro = fields.TextField(default="")
created_at = fields.DatetimeField(auto_now_add=True)
def __str__(self):
return f"{self.pk}#{self.username}"
def rowVariant(self) -> str:
if not self.is_active:
return "warning"
return ""
def cellVariants(self) -> dict:
if self.is_active:
return {
"intro": "info",
}
return {}
class PydanticMeta:
computed = ("rowVariant", "cellVariants")Deploy fastapi app by gunicorn+uvicorn or reference https://fastapi.tiangolo.com/deployment/.
See restful api docs.
See documents for reference.
- Just give a star!
- Donation.
- Click Ads
Donate money by paypal to my account long2ice.
- fastapi ,high performance async api framework.
- tortoise-orm ,familiar asyncio ORM for python.
This project is licensed under the Apache-2.0 License.