zt-devops-cli 0.1.8__tar.gz → 0.2.0__tar.gz

zt_devops_cli-0.2.0/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: zt-devops-cli
+Version: 0.2.0
+Summary: DevOps 平台迭代管理 CLI
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: playwright>=1.40.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: pyyaml>=6.0
+
+# DevOps CLI
+
+蓝鲸 DevOps（ZTN）平台迭代、任务、缺陷等能力的命令行工具。
+
+## 打包
+
+```bash
+uv pip install --upgrade build twine
+uv build
+uv publish dist/*
+```
+
+## 安装
+
+**源码安装**
+
+```bash
+pip install -e .
+```
+
+**pip / pipx 安装**
+
+```bash
+pipx install zt-devops-cli
+```
+
+## 使用
+
+### 全局选项
+
+根命令 `zt-devops-cli` 支持：
+
+| 选项 | 说明 |
+|------|------|
+| `-p` / `--project` | 默认项目 ID；子命令若再传 `-p` 会覆盖 |
+| `-o` / `--output` | `json`（默认）或 `human`；列表类在 `human` 下为表格，部分写操作在 `human` 下仅输出简短成功信息 |
+
+示例：
+
+```bash
+zt-devops-cli -o human -p b9f157 bug list --num 1 --size 20
+```
+
+### 登录
+
+首次或 cookie 失效时会走浏览器登录流程；成功后将 cookie 写入本地缓存。
+
+```bash
+zt-devops-cli login
+```
+
+需要弹出窗口手动登录时（无环境变量自动填表时）：
+
+```bash
+zt-devops-cli login --headed
+```
+
+无头自动登录依赖环境变量 `ZT_SSO_USERNAME`、`ZT_SSO_PASSWORD`（见 `auth` 模块说明）。
+
+### 项目管理
+
+```bash
+zt-devops-cli project list
+```
+
+### ZTeam 项目
+
+```bash
+zt-devops-cli zteam-project list --project f39507
+```
+
+### 迭代管理
+
+**迭代列表**
+
+```bash
+zt-devops-cli sprint list --project k64352
+```
+
+**迭代提测列表**
+
+```bash
+zt-devops-cli sprint test-list --project b9f157 \
+  --search "BSC_V26.701.01" \
+  --num 1 \
+  --size 10
+```
+
+可选筛选：`--result`、`--create-user`、`--create-time`、`--principal`、`--obj-id`（均可重复传入）。
+
+**创建迭代**
+
+```bash
+zt-devops-cli sprint create --project k64352 \
+  --title "迭代名称" \
+  --start-date 2026-04-04 \
+  --end-date 2026-05-30 \
+  --purpose "迭代目标"
+```
+
+可选：`--test-start`、`--test-end`。
+
+**启用 / 删除 / 完成迭代**
+
+```bash
+zt-devops-cli sprint start --project k64352 --sprint-id <id>
+zt-devops-cli sprint delete --project k64352 --sprint-id <id>
+zt-devops-cli sprint done --project k64352 --sprint-id <id>
+```
+
+### 任务管理
+
+**查询任务列表（TASK）**
+
+必填：`-p`、`--start-date`、`--end-date`。可选：`--creator`、`--num`、`--size`、`--remember` / `--no-remember`（默认 `--no-remember`）。
+
+```bash
+zt-devops-cli task list --project f39507 \
+  --start-date 2026-04-01 \
+  --end-date 2026-04-30 \
+  --creator zt07905
+```
+
+**创建任务（TASK）**
+
+必填：`-p`、`-t`、`--owner`、`--estimate-start`、`--estimate-end`、`--zteam-project-id`（项目 ID 来自 `project list`，ZTeam 项目 ID 来自 `zteam-project list`）。
+
+```bash
+zt-devops-cli task create \
+  --project "<project-id>" \
+  --title "<任务标题>" \
+  --owner zt07905 \
+  --estimate-start 2026-04-01 \
+  --estimate-end 2026-04-30 \
+  --zteam-project-id "<zteam-project-id>"
+```
+
+可选：`--model-type-id`、`--priority`、`--editor-type`、`--desc`、`--parent-id`、`--demand-classify`、`--origin-hours`、`--remain-hours`；扩展字段使用 `--field fieldId=value`（可多次）。
+
+### 缺陷管理
+
+**查询缺陷列表（BUG）**
+
+与页面表格筛选一致。必填：`-p`。常用可选：`--num`、`--size`、`--remember` / `--no-remember`（默认 `--no-remember`）、`--operator`（逗号分隔多账号）、`--zteam-project`、`--owner-field` / `--owner`、`--state`（状态 ID，可先 `bug states`）、`--creator`、`--create-date` 或 `--create-start` + `--create-end`。
+
+```bash
+zt-devops-cli bug list --project b9f157 \
+  --num 1 \
+  --size 20
+```
+
+**查询缺陷状态可选项**
+
+```bash
+zt-devops-cli bug states --project b9f157
+```
+
+默认 `--all`；若与页面不一致可尝试 `--no-all`。
+
+**创建缺陷（BUG）**
+
+对应 `POST .../issue/{project}`。`--owner` 同时写入经办人与缺陷责任人；迭代、ZTeam、严重程度、分类、发现阶段等使用代码内固定 `fieldId`（与团队抓包一致）。若你们项目字段不同，需改源码中的 `instance_values` 映射。
+
+| 选项 | 说明 |
+|------|------|
+| `-p` / `--project` | 项目 ID |
+| `--zteam-project-id` | ZTeam 项目 ID |
+| `--sprint-id` | 关联迭代 ID；可不关联时传空字符串 `""` |
+| `-t` / `--title` | 标题 |
+| `--severity` / `--type` / `--discovery-phase` | 与表单选项的 **value** 一致（非中文展示名） |
+| `--owner` | 账号 |
+| `--priority` | 默认 `CENTRAL` |
+| `--desc` / `--desc-editor-type` | 描述 HTML 与编辑器类型，默认带四段模板 |
+| `--parent-id`、`--model-type-id`、`--demand-classify` | 可选或保持默认 |
+
+```bash
+zt-devops-cli bug create -p b9f157 \
+  --zteam-project-id 15678224 \
+  --sprint-id 3129a9cd7315457eb2963bfe19919e72 \
+  -t "缺陷标题示例" \
+  --owner zt07905 \
+  --severity 9Clfj3I8fR \
+  --type bgEHPFOjFt \
+  --discovery-phase vENjmMhXMC
+```
+
+**缺陷工作流（接受 / 已解决 / 已验证 / 关闭 / 重新打开 / 拒绝）**
+
+均调用 `POST .../issue_direction/{project}/next`。各动作对应的 `nextNodeId` 写死在 `api.BUG_DIRECTION_NEXT_NODE_IDS`（与某项目浏览器抓包一致）；若你们项目工作流节点不同，需改源码中该表。
+
+- **位置参数 `ISSUE_ID`**：缺陷 ID（必填）。
+- **`-p` / `--project`**：可省略，顺序为「子命令 `-p` → 根命令 `-p` → `config.yaml` 的 `default_project`」。
+- **`--operator`**：可省略，逗号分隔多个账号；顺序为「CLI → 环境变量 `ZT_DEVOPS_DEFAULT_OPERATOR` 或 `ZT_DEVOPS_OPERATOR` → `config.yaml` 的 `default_operator`」。
+- **`--comment`**：可选。
+
+```bash
+zt-devops-cli -p b9f157 bug accept <issue-id> --comment '<p>说明</p>'
+zt-devops-cli bug resolve -p b9f157 <issue-id> --operator zt07905
+zt-devops-cli bug verify <issue-id> --operator zt07905,user02
+zt-devops-cli bug close -p b9f157 <issue-id>
+zt-devops-cli bug reopen -p b9f157 <issue-id>
+zt-devops-cli bug reject -p b9f157 <issue-id>
+```
+
+在 `~/.zt-devops-cli/config.yaml` 中可写：
+
+```yaml
+default_project: b9f157
+default_operator: zt07905
+```
+
+**删除缺陷**
+
+```bash
+zt-devops-cli bug delete -p b9f157 -i <issue-id>
+zt-devops-cli bug delete -p b9f157 -i <issue-id> -y
+```
+
+`-y` / `--yes` 跳过交互确认。
+
+### 需求管理
+
+`issue` 命令组已预留，当前版本无子命令。可用 `zt-devops-cli issue --help` 查看。
+
+## 配置
+
+- Cookie 缓存：`~/.zt-devops-cli/cookies.json`
+- 配置文件：`~/.zt-devops-cli/config.yaml`（常用键：`default_project` 等同根命令 `-p`；`default_operator` 供缺陷流转子命令在未传 `--operator` 时使用）

zt_devops_cli-0.2.0/README.md

@@ -0,0 +1,228 @@
+# DevOps CLI
+
+蓝鲸 DevOps（ZTN）平台迭代、任务、缺陷等能力的命令行工具。
+
+## 打包
+
+```bash
+uv pip install --upgrade build twine
+uv build
+uv publish dist/*
+```
+
+## 安装
+
+**源码安装**
+
+```bash
+pip install -e .
+```
+
+**pip / pipx 安装**
+
+```bash
+pipx install zt-devops-cli
+```
+
+## 使用
+
+### 全局选项
+
+根命令 `zt-devops-cli` 支持：
+
+| 选项 | 说明 |
+|------|------|
+| `-p` / `--project` | 默认项目 ID；子命令若再传 `-p` 会覆盖 |
+| `-o` / `--output` | `json`（默认）或 `human`；列表类在 `human` 下为表格，部分写操作在 `human` 下仅输出简短成功信息 |
+
+示例：
+
+```bash
+zt-devops-cli -o human -p b9f157 bug list --num 1 --size 20
+```
+
+### 登录
+
+首次或 cookie 失效时会走浏览器登录流程；成功后将 cookie 写入本地缓存。
+
+```bash
+zt-devops-cli login
+```
+
+需要弹出窗口手动登录时（无环境变量自动填表时）：
+
+```bash
+zt-devops-cli login --headed
+```
+
+无头自动登录依赖环境变量 `ZT_SSO_USERNAME`、`ZT_SSO_PASSWORD`（见 `auth` 模块说明）。
+
+### 项目管理
+
+```bash
+zt-devops-cli project list
+```
+
+### ZTeam 项目
+
+```bash
+zt-devops-cli zteam-project list --project f39507
+```
+
+### 迭代管理
+
+**迭代列表**
+
+```bash
+zt-devops-cli sprint list --project k64352
+```
+
+**迭代提测列表**
+
+```bash
+zt-devops-cli sprint test-list --project b9f157 \
+  --search "BSC_V26.701.01" \
+  --num 1 \
+  --size 10
+```
+
+可选筛选：`--result`、`--create-user`、`--create-time`、`--principal`、`--obj-id`（均可重复传入）。
+
+**创建迭代**
+
+```bash
+zt-devops-cli sprint create --project k64352 \
+  --title "迭代名称" \
+  --start-date 2026-04-04 \
+  --end-date 2026-05-30 \
+  --purpose "迭代目标"
+```
+
+可选：`--test-start`、`--test-end`。
+
+**启用 / 删除 / 完成迭代**
+
+```bash
+zt-devops-cli sprint start --project k64352 --sprint-id <id>
+zt-devops-cli sprint delete --project k64352 --sprint-id <id>
+zt-devops-cli sprint done --project k64352 --sprint-id <id>
+```
+
+### 任务管理
+
+**查询任务列表（TASK）**
+
+必填：`-p`、`--start-date`、`--end-date`。可选：`--creator`、`--num`、`--size`、`--remember` / `--no-remember`（默认 `--no-remember`）。
+
+```bash
+zt-devops-cli task list --project f39507 \
+  --start-date 2026-04-01 \
+  --end-date 2026-04-30 \
+  --creator zt07905
+```
+
+**创建任务（TASK）**
+
+必填：`-p`、`-t`、`--owner`、`--estimate-start`、`--estimate-end`、`--zteam-project-id`（项目 ID 来自 `project list`，ZTeam 项目 ID 来自 `zteam-project list`）。
+
+```bash
+zt-devops-cli task create \
+  --project "<project-id>" \
+  --title "<任务标题>" \
+  --owner zt07905 \
+  --estimate-start 2026-04-01 \
+  --estimate-end 2026-04-30 \
+  --zteam-project-id "<zteam-project-id>"
+```
+
+可选：`--model-type-id`、`--priority`、`--editor-type`、`--desc`、`--parent-id`、`--demand-classify`、`--origin-hours`、`--remain-hours`；扩展字段使用 `--field fieldId=value`（可多次）。
+
+### 缺陷管理
+
+**查询缺陷列表（BUG）**
+
+与页面表格筛选一致。必填：`-p`。常用可选：`--num`、`--size`、`--remember` / `--no-remember`（默认 `--no-remember`）、`--operator`（逗号分隔多账号）、`--zteam-project`、`--owner-field` / `--owner`、`--state`（状态 ID，可先 `bug states`）、`--creator`、`--create-date` 或 `--create-start` + `--create-end`。
+
+```bash
+zt-devops-cli bug list --project b9f157 \
+  --num 1 \
+  --size 20
+```
+
+**查询缺陷状态可选项**
+
+```bash
+zt-devops-cli bug states --project b9f157
+```
+
+默认 `--all`；若与页面不一致可尝试 `--no-all`。
+
+**创建缺陷（BUG）**
+
+对应 `POST .../issue/{project}`。`--owner` 同时写入经办人与缺陷责任人；迭代、ZTeam、严重程度、分类、发现阶段等使用代码内固定 `fieldId`（与团队抓包一致）。若你们项目字段不同，需改源码中的 `instance_values` 映射。
+
+| 选项 | 说明 |
+|------|------|
+| `-p` / `--project` | 项目 ID |
+| `--zteam-project-id` | ZTeam 项目 ID |
+| `--sprint-id` | 关联迭代 ID；可不关联时传空字符串 `""` |
+| `-t` / `--title` | 标题 |
+| `--severity` / `--type` / `--discovery-phase` | 与表单选项的 **value** 一致（非中文展示名） |
+| `--owner` | 账号 |
+| `--priority` | 默认 `CENTRAL` |
+| `--desc` / `--desc-editor-type` | 描述 HTML 与编辑器类型，默认带四段模板 |
+| `--parent-id`、`--model-type-id`、`--demand-classify` | 可选或保持默认 |
+
+```bash
+zt-devops-cli bug create -p b9f157 \
+  --zteam-project-id 15678224 \
+  --sprint-id 3129a9cd7315457eb2963bfe19919e72 \
+  -t "缺陷标题示例" \
+  --owner zt07905 \
+  --severity 9Clfj3I8fR \
+  --type bgEHPFOjFt \
+  --discovery-phase vENjmMhXMC
+```
+
+**缺陷工作流（接受 / 已解决 / 已验证 / 关闭 / 重新打开 / 拒绝）**
+
+均调用 `POST .../issue_direction/{project}/next`。各动作对应的 `nextNodeId` 写死在 `api.BUG_DIRECTION_NEXT_NODE_IDS`（与某项目浏览器抓包一致）；若你们项目工作流节点不同，需改源码中该表。
+
+- **位置参数 `ISSUE_ID`**：缺陷 ID（必填）。
+- **`-p` / `--project`**：可省略，顺序为「子命令 `-p` → 根命令 `-p` → `config.yaml` 的 `default_project`」。
+- **`--operator`**：可省略，逗号分隔多个账号；顺序为「CLI → 环境变量 `ZT_DEVOPS_DEFAULT_OPERATOR` 或 `ZT_DEVOPS_OPERATOR` → `config.yaml` 的 `default_operator`」。
+- **`--comment`**：可选。
+
+```bash
+zt-devops-cli -p b9f157 bug accept <issue-id> --comment '<p>说明</p>'
+zt-devops-cli bug resolve -p b9f157 <issue-id> --operator zt07905
+zt-devops-cli bug verify <issue-id> --operator zt07905,user02
+zt-devops-cli bug close -p b9f157 <issue-id>
+zt-devops-cli bug reopen -p b9f157 <issue-id>
+zt-devops-cli bug reject -p b9f157 <issue-id>
+```
+
+在 `~/.zt-devops-cli/config.yaml` 中可写：
+
+```yaml
+default_project: b9f157
+default_operator: zt07905
+```
+
+**删除缺陷**
+
+```bash
+zt-devops-cli bug delete -p b9f157 -i <issue-id>
+zt-devops-cli bug delete -p b9f157 -i <issue-id> -y
+```
+
+`-y` / `--yes` 跳过交互确认。
+
+### 需求管理
+
+`issue` 命令组已预留，当前版本无子命令。可用 `zt-devops-cli issue --help` 查看。
+
+## 配置
+
+- Cookie 缓存：`~/.zt-devops-cli/cookies.json`
+- 配置文件：`~/.zt-devops-cli/config.yaml`（常用键：`default_project` 等同根命令 `-p`；`default_operator` 供缺陷流转子命令在未传 `--operator` 时使用）

{zt_devops_cli-0.1.8 → zt_devops_cli-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "zt-devops-cli"
-version = "0.1.8"
+version = "0.2.0"
 description = "DevOps 平台迭代管理 CLI"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -16,7 +16,7 @@ dependencies = [
 ]
 
 [project.scripts]
-zt-devops-cli = "devops_cli.cli:main"
+zt-devops-cli = "zt_devops_cli.cli:main"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]