Python 项目 Monorepo 配置最佳实践

Python 项目 Monorepo 配置最佳实践

uv-monorepo Example of a monorepo setup for python projects using uv 项目地址: https://gitcode.com/gh_mirrors/uv/uv-monorepo

1. 项目介绍

本项目是基于开源工具 uv 的一个 Python 项目 Monorepo 配置示例。Monorepo 是指将多个项目或包存储在一个单一的代码库中。这种方式可以简化包管理和版本控制，使得跨项目依赖和协作更加高效。uv 是一个轻量级的 Python 包管理工具，它支持 workspace 概念，适合于 Monorepo 的配置。

2. 项目快速启动

环境准备

• 安装 Docker，确保 Docker 可以正常运行。
• 克隆项目到本地：

git clone https://github.com/JasperHG90/uv-monorepo.git
cd uv-monorepo

初始化项目

• 启动 Docker 容器：

docker-compose up --build

• 在容器内部执行项目初始化：

docker exec -it uv-monorepo bash
cd /app
just s

just s 命令会执行 justfile 中的 setup 任务，初始化项目环境。

运行测试

• 运行单元测试：

just t

构建项目

• 构建项目：

just b

3. 应用案例和最佳实践

组织结构

项目的目录结构如下：

uv-monorepo/
├── .cache/
├── .devcontainer/
├── scripts/
├── shared/
│   └── utils/
├── src/
│   └── core/
├── tests/
├── .gitignore
├── .pre-commit-config.yaml
├── .python-version
├── Dockerfile
├── LICENSE.txt
├── README.md
├── justfile
├── pyproject.toml
└── uv.lock

• shared/ 目录存放被多个项目共享的代码。
• src/ 目录存放主要的业务逻辑代码。
• tests/ 目录存放单元测试代码。
• scripts/ 目录存放辅助脚本。

使用 uv

• uv 使用 pyproject.toml 文件来配置项目依赖和构建过程。
• 在 pyproject.toml 中定义 workspace，使得 uv 能够处理 Monorepo 中的多个包。

[tool.uv]
workspaces = ["src/core", "shared/utils"]

集成 pre-commit

• 使用 pre-commit来自动化代码风格检查和格式化。
• 在 .pre-commit-config.yaml 中配置 pre-commit 钩子。

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.6.0
    hooks:
      - id: autopep8
      - id: yapf

4. 典型生态项目

Monorepo 配置适用于多种类型的项目，以下是一些典型应用场景：

• 微服务架构：将所有微服务放在一个 Monorepo 中，可以更容易地管理跨服务的依赖。
• 大型团队协作：多个团队可以独立开发，同时共享通用库和组件。
• 开源项目：开源项目中的多个组件和工具可以集中管理，方便维护和迭代。

通过以上实践，可以有效地利用 Monorepo 和 uv 工具来提升 Python 项目的开发效率和管理便捷性。

uv-monorepo Example of a monorepo setup for python projects using uv 项目地址: https://gitcode.com/gh_mirrors/uv/uv-monorepo