- 移除 pyproject.toml 和 uv.lock - 更新 SKILL.md:使用 uv run --with 按需加载依赖 - 更新 README.md:添加多行格式的测试命令 - 更新项目规范文档 - 修复脚本:支持从任意位置执行 - 新增 uv-with-dependency-management 规范
62 lines
2.8 KiB
Markdown
62 lines
2.8 KiB
Markdown
# 多平台依赖管理
|
||
|
||
## Purpose
|
||
|
||
为不同平台提供特定的依赖配置,解决平台特定的依赖兼容性问题(如 macOS x86_64 的 docling-parse 版本限制)。通过 `uv run --with` 方式按需加载依赖,在文档中提供平台特定的命令示例。
|
||
|
||
## Requirements
|
||
|
||
### Requirement: 平台检测文档
|
||
系统必须在 SKILL.md 中提供平台检测方法和平台特定的 `uv run --with` 命令示例。
|
||
|
||
#### Scenario: 平台检测命令
|
||
- **WHEN** 用户阅读 SKILL.md 中的多平台依赖安装指南
|
||
- **THEN** 系统必须提供以下平台的检测命令:
|
||
- macOS / Linux: `uname -m` 和 `uname -s`
|
||
- Windows: PowerShell 环境变量检测
|
||
- Python 跨平台检测: `import platform; print(f'{platform.system()}-{platform.machine()}')`
|
||
|
||
#### Scenario: macOS x86_64 特殊说明
|
||
- **WHEN** 用户在 macOS x86_64 平台阅读 PDF 解析依赖的安装说明
|
||
- **THEN** 系统必须明确说明以下特殊要求:
|
||
- 必须使用 Python 3.12
|
||
- `docling-parse` 5.x 无 x86_64 wheel,必须使用 4.0.0
|
||
- 提供完整的 `uv run --python 3.12 --with "docling==2.40.0" --with "docling-parse==4.0.0" --with "numpy<2" ...` 命令示例
|
||
|
||
#### Scenario: 每个平台的运行命令
|
||
- **WHEN** 用户阅读 SKILL.md
|
||
- **THEN** 系统必须为每个平台(Windows/macOS Intel/macOS ARM/Linux)和每种文档格式提供清晰的 `uv run --with` 命令示例
|
||
- **AND** 命令必须包含所有必需的依赖包
|
||
|
||
### Requirement: 平台检测文档
|
||
系统必须在 `SKILL.md` 中提供平台检测方法和平台特定的安装指南。
|
||
|
||
#### Scenario: 平台检测命令
|
||
- **WHEN** 用户阅读 `SKILL.md` 中的多平台依赖安装指南
|
||
- **THEN** 系统必须提供以下平台的检测命令:
|
||
- macOS / Linux: `uname -m` 和 `uname -s`
|
||
- Windows: PowerShell 环境变量检测
|
||
- Python 跨平台检测: `import platform; print(f'{platform.system()}-{platform.machine()}')`
|
||
|
||
#### Scenario: macOS x86_64 特殊说明
|
||
- **WHEN** 用户在 macOS x86_64 平台阅读 PDF 解析依赖的安装说明
|
||
- **THEN** 系统必须明确说明以下特殊要求:
|
||
- 必须使用 Python 3.12
|
||
- `docling-parse` 5.x 无 x86_64 wheel,必须使用 4.0.0
|
||
|
||
#### Scenario: 每个平台的安装命令
|
||
- **WHEN** 用户阅读 `SKILL.md`
|
||
- **THEN** 系统必须为每个平台(Windows/macOS Intel/macOS ARM/Linux)提供清晰的 `uv run` 命令示例
|
||
|
||
### Requirement: Lock 文件管理
|
||
系统必须移除 `uv.lock` 文件,每次 `uv run` 都是全新的依赖解析。
|
||
|
||
#### Scenario: 移除 uv.lock 文件
|
||
- **WHEN** 用户查看项目根目录
|
||
- **THEN** 系统必须不包含 uv.lock 文件
|
||
- **AND** 依赖版本由文档中的版本约束说明
|
||
|
||
#### Scenario: gitignore 配置(可选)
|
||
- **WHEN** 用户查看项目的 `.gitignore` 文件
|
||
- **THEN** 系统可以包含 `uv.lock` 条目以确保不会误提交(如果用户重新创建了 lock 文件)
|