pingcode

# PingCode Skill

通过 PingCode Open API 操作研发管理平台数据。

## 前置条件

1. 在 PingCode 企业后台创建应用，获取 `Client ID` 和 `Client Secret`
2. 配置应用的数据访问范围
3. **设置环境变量**（不要直接修改脚本）：
   ```bash
   export PINGCODE_CLIENT_ID="your_client_id"
   export PINGCODE_CLIENT_SECRET="your_client_secret"
   ```

## 功能脚本

### 获取我的工作项

```bash
python3 scripts/get_my_tasks.py
```

输出示例：
```
📋 你的工作项列表 (共 15 条，显示前 20 条)

⬜ [5e05d844] 优化登录页面性能
   项目: Web端重构 | 状态: 待处理 | 优先级: 高
   负责人: 张三

🔄 [5e05d845] API 接口文档更新
   项目: 开放平台 | 状态: 进行中 | 优先级: 中
   负责人: 李四
```

### 获取项目列表

```bash
# 列出所有项目
python3 scripts/get_projects.py

# 以 JSON 格式输出
python3 scripts/get_projects.py --json

# 限制返回数量
python3 scripts/get_projects.py --limit 50
```

输出示例：
```
📁 项目列表 (共 3 个)

1. 🟢 [5fb277c1] 敏捷示例项目
   类型: 软件开发 | 状态: 进行中 | 负责人: anytao
   描述: 示例项目用于演示敏捷开发流程...

2. 🟢 [5fb277c2] 产品官网重构
   类型: 软件开发 | 状态: 进行中 | 负责人: 张三
   描述: 官网前端重构项目...
```

### 获取指定项目的全部工作项

```bash
# 通过项目名称查询
python3 scripts/get_project_workitems.py --project_name "敏捷示例"

# 通过项目 ID 查询
python3 scripts/get_project_workitems.py --project_id 62ded365

# 以 JSON 格式输出
python3 scripts/get_project_workitems.py --project_name "敏捷示例" --json
```

输出示例：
```
📋 项目工作项 - 敏捷示例 (共 82 条)

⬜ [5fb277c1] 申请售后
   类型: 需求 | 状态: 待处理 | 优先级: 普通
   负责人: anytao

⬜ [5fb277c1] 支付宝支付
   类型: 需求 | 状态: 待处理 | 优先级: 普通
   负责人: anytao
```

### 生成项目周报

```bash
# 生成周报并输出到控制台
python3 scripts/generate_weekly_report.py

# 指定项目和名称
python3 scripts/generate_weekly_report.py --project_id xxx --project_name "PingCode 重构"

# 输出到文件
python3 scripts/generate_weekly_report.py --output /tmp/weekly_report.md
```

输出示例：
```markdown
# 📊 项目周报
生成时间：2024-03-01 14:30

## 📈 数据概览
- 工作项总数：45
- 本周完成：12 (26.7%)
- 进行中：15
- 待处理：18
- 延期风险：3

## ⚠️ 延期风险
发现 3 个工作项已延期，建议优先处理：
- 优化登录性能 (截止：2024-02-28)
```

### 更新工作项

```bash
# 分配负责人
python3 scripts/update_workitem.py --workitem_id 5fb277c1 --assignee anytao

# 设置开始和截止时间
python3 scripts/update_workitem.py --workitem_id 5fb277c1 --start_date "2026-03-12" --due_date "2026-03-20"

# 同时更新多个字段
python3 scripts/update_workitem.py --workitem_id 5fb277c1 --assignee anytao --start_date "2026-03-12" --due_date "2026-03-20" --priority "高"

# 更新状态
python3 scripts/update_workitem.py --workitem_id 5fb277c1 --status "进行中"
```

### 创建工作项（待实现）

```bash
python3 scripts/create_workitem.py --title "修复登录bug" --type bug --priority high
```

## API 参考

详见 `references/api_docs.md` 或访问 https://open.pingcode.com/

## 常用 API 端点

| 功能 | 端点 |
|------|------|
| 获取令牌 | `GET /v1/auth/token` |
| 获取工作项 | `GET /v1/project/work_items` |
| 创建工作项 | `POST /v1/project/work_items` |
| 获取项目 | `GET /v1/agile/projects` |
| 获取迭代 | `GET /v1/agile/iterations` |

## 注意事项

1. **凭证安全**：使用环境变量 `PINGCODE_CLIENT_ID` 和 `PINGCODE_CLIENT_SECRET`，不要硬编码到脚本中
2. **频率限制**：每分钟最多 200 次请求
3. **Token 有效期**：30 天
4. **分页**：默认每页 30 条，最大 100 条