安装

使用你偏好的包管理器安装 starlette-admin。

pip install starlette-admin

uv add starlette-admin

starlette-admin 要求 Python 3.11 或更高版本。

核心包本身与后端无关。要为你的应用构建管理界面，请在基础包之外，为你的数据层（如 SQLAlchemy、Beanie、MongoEngine 或 Tortoise ORM）安装相应的集成。

包含的依赖

基础安装已包含运行管理界面所需的一切，默认不安装任何可选依赖。

基于 FastAPI 构建的应用无需额外的集成，因为 FastAPI 构建于 Starlette 之上。只需将管理界面挂载到你现有的 FastAPI 应用即可。

可选依赖

starlette-admin 提供以下可选依赖：

• pdf：添加 PDF 导出支持（reportlab）。
• i18n：添加国际化支持（Babel）。
• tinymce：添加富文本编辑器支持。会安装 nh3，用于清理 TinyMCEEditorField 提交的 HTML。
• s3：添加 S3 兼容对象存储支持。会安装 aiobotocore，用于向 AWS S3 以及 MinIO 等兼容对象存储服务进行异步上传。

将一个或多个可选依赖与 starlette-admin 一起安装：

# Install the `pdf` extra.
pip install "starlette-admin[pdf]"

# Install multiple extras.
pip install "starlette-admin[i18n,pdf,s3]"

# Install the `pdf` extra.
uv add "starlette-admin[pdf]"

# Install multiple extras.
uv add "starlette-admin[i18n,pdf,s3]"

从源码安装

要使用尚未发布的最新更改，请直接从 GitHub 仓库安装该包。

pip install "git+https://github.com/jowilf/starlette-admin.git"

uv add "git+https://github.com/jowilf/starlette-admin.git"

后续步骤

• 快速开始：使用真实数据构建你的第一个管理界面。
• 核心概念：了解 starlette-admin 背后的核心架构与设计原则。