SQLAdmin 教程：安装与配置指南

SQLAdmin 教程：安装与配置指南

sqladminSQLAlchemy Admin for FastAPI and Starlette项目地址:https://gitcode.com/gh_mirrors/sq/sqladmin

1. 项目目录结构及介绍

在 sqladmin 开源项目中，主要的目录结构如下：

• docs：存放项目的文档资料，包括 Markdown 格式的说明文件。
• sqladmin：核心代码库，包含主要的功能实现。
• tests：测试用例目录，用于验证软件功能的正确性。
• codecov.yml：覆盖率报告配置文件。
• gitignore：定义了 Git 忽略的文件列表。
• CHANGELOG.md：变更日志，记录每次版本更新的内容。
• CONTRIBUTING.md：贡献指南，描述如何参与项目开发。
• LICENSE.md：项目许可证信息，本项目遵循 BSD-3-Clause 许可。
• README.md：项目简介，包括快速入门和特性介绍。
• mkdocs.yml：Markdown 文档站点的配置文件。
• pyproject.toml：Python 项目的配置文件，管理依赖和构建设置。

这些目录和文件构成了一整个功能完备的 SQLAlchemy 集成管理界面应用。

2. 项目启动文件介绍

该项目没有明确的单一启动文件，但在快速启动示例中，我们可以看到以下两部分：

• FastAPI 启动示例：

  from fastapi import FastAPI
  from sqladmin import Admin, ModelView
  
  app = FastAPI()
  
  admin = Admin(app, engine)
  
  class UserAdmin(ModelView):
      model = User
      column_list = [User.id, User.name]
  
  admin.add_view(UserAdmin)
  

  这段代码创建了一个基于 FastAPI 的应用程序，并使用 sqladmin 创建了一个管理用户数据的视图。

• Starlette 启动示例：

  from sqladmin import Admin, ModelView
  from starlette.applications import Starlette
  
  app = Starlette()
  
  admin = Admin(app, engine)
  
  class UserAdmin(ModelView):
      model = User
      column_list = [User.id, User.name]
  
  admin.add_view(UserAdmin)
  

  类似地，这是使用 Starlette 框架构建的应用程序，同样展示了添加用户管理视图的方法。

启动应用时，需要确保已安装所有必要的依赖并拥有一个有效的 SQLAlchemy 数据引擎（如 engine）。

3. 项目的配置文件介绍

sqladmin 并不直接提供一个标准的配置文件，而是通过初始化对象和传递参数进行配置。例如，你可以自定义 SQLAlchemy 的连接字符串、认证方式、模板以及其他特定视图的配置。这些配置通常在创建 Admin 对象时进行，如下所示：

from sqlalchemy.orm import sessionmaker
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import create_engine

Base = declarative_base()

# 创建数据库引擎
engine = create_engine('your_database_connection_string')

# 配置认证和其他参数
admin_config = {
    'auth': {'username': 'admin', 'password': 'secret'},
    'templates_dir': '/path/to/custom/templates',
}

# 创建 Admin 实例，传入配置
admin = Admin(app=app, engine=engine, config=admin_config)

在这个例子中，admin_config 字典包含了认证信息（用户名和密码）以及自定义模板目录。这允许你根据需求个性化你的 SQLAdmin 应用。

请注意，具体的配置选项可能会因版本更新或额外扩展而有所不同。查阅项目文档或源码可以获取最新的配置选项。

sqladminSQLAlchemy Admin for FastAPI and Starlette项目地址:https://gitcode.com/gh_mirrors/sq/sqladmin