# yuanboot Python

简单、轻量、快速的 Python 微服务框架，基于 FastAPI、Uvicorn 和依赖注入构建，支持 Python 3.11+。通过统一宿主管理 Web API、MVC、gRPC 和后台服务，为业务项目提供配置、数据访问、服务发现和可观测性。

(opens new window) (opens new window) (opens new window) (opens new window) (opens new window)

快速上手 → · 框架源码 (opens new window) · 版本与安装

# 框架特色

FastAPI 路由、请求校验、OpenAPI、WebSocket 与 MVC 控制器。
Singleton、Scoped、Transient 依赖注入，统一管理请求作用域和资源释放。
Web、gRPC、Console 共用配置、生命周期和后台服务机制。
YAML / JSON、多环境配置、环境变量、Nacos / Apollo 配置中心。
MySQL、Redis、服务注册与发现、HTTP 客户端与任务调度。
结构化日志、Request ID、健康检查、Prometheus 和 JWT。
七类项目模板（含 Admin 管理后台），支持创建、运行和构建业务项目。

创建管理后台 →：用户、角色、菜单、部门、系统配置，Vue 3 前端与 Python 权限 API。

# 框架架构

yuanboot Python 框架架构：业务应用、服务宿主、配置与依赖注入、基础组件

查看完整架构图

Web 使用 FastAPI / Uvicorn，gRPC 使用 grpc.aio，后台任务使用 Console Host。各类宿主共用配置、依赖注入和生命周期，业务通过服务接口使用数据、缓存和服务治理组件。构建与请求流程见基本概念与架构。

# 安装框架

在 Python 3.11+ 环境中安装已发布版本：

python -m venv .venv
source .venv/bin/activate
python -m pip install 'yuanboot[all]==0.2.0'
yuanbootctl-python --version

Windows 激活虚拟环境使用 .venv\Scripts\Activate.ps1。组件按需安装，见版本与安装。也可安装 yuanbootctl-python==0.2.0 自动获取同版本框架和项目命令；无需 Python 的独立可执行文件见CLI 工具。

# 简单示例

将下面代码保存为 main.py，执行 python main.py：

from yuanboot.web import create_default_builder
from yuanboot.web.endpoints import use_actuator


def endpoints(router):
    use_actuator(router)

    @router.get("/info")
    def info():
        return {"info": "ok"}


host = create_default_builder(endpoints).build()
app = host.app

if __name__ == "__main__":
    host.run()

访问 http://127.0.0.1:8080/info 查看响应，访问 http://127.0.0.1:8080/docs 调试接口。

# 文档导航

开发阶段	文档
创建项目	快速上手、CLI 工具、版本与安装
理解框架	基本概念与架构、代码展示
配置服务	配置文件与多环境、组件配置与使用
开发接口	服务路由、MVC 控制器与视图、依赖注入
后台与 RPC	Console 与后台服务、gRPC 服务
AI 辅助开发	AI 辅助编程指南、框架规格文档
运行与部署	日志与可观测性、Docker 部署、宿主机部署