[U] Wrap into uv tool.

This commit is contained in:
2026-03-20 20:19:33 +08:00
parent db20b739cd
commit ca9e32763e
14 changed files with 844 additions and 433 deletions

View File

@@ -4,47 +4,57 @@
## 文档结构
- `README.md` - 项目主文档
- `USAGE.md` - 使用说明文档
- `README.md` - 文档索引
- `uv-tool.md` - `uv tool` 安装、运行、配置与发布说明
- `USAGE.md` - 命令使用说明,重点覆盖 `view`
- `cloudflare_setup.md` - Cloudflare 配置说明
- `progress-tracker.md` - 进度跟踪文档
- `requirements.md` - 需求文档
- `workplan.md` - 工作计划文档
## 快速开始
1. 安装项目
1. 从源码直接运行
```bash
pip install -e .
uv tool run --from . config-man --help
```
2. 查看帮助
2. 安装为本地工具
```bash
python main.py --help
uv tool install --from . config-man
config-man --help
```
3. 使用查看功能:
3. 查看功能验证
```bash
python main.py view --version 0.30 --mock
config-man view --version 0.30 --mock
```
## 开发指南
1. 安装开发依赖:
```bash
pip install -e ".[dev]"
uv sync --extra dev
```
2. 运行测试:
```bash
pytest
uv run pytest
```
3. 代码格式化:
```bash
black src/ tests/
uv run black src/ tests/
```
4. 类型检查:
```bash
mypy src/
uv run mypy src/
```