chreode-ship 0.8.2__py3-none-any.whl

chreode_ship-0.8.2.dist-info/METADATA

@@ -0,0 +1,127 @@
+Metadata-Version: 2.5
+Name: chreode-ship
+Version: 0.8.2
+Summary: Independent project setup for Ship skills, CI feedback, and Codex Review Gate
+Project-URL: Source, https://github.com/Chreode/ship
+Project-URL: Issues, https://github.com/Chreode/ship/issues
+Project-URL: Documentation, https://github.com/Chreode/ship/blob/main/docs/install.md
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: tomlkit<1,>=0.13
+Description-Content-Type: text/markdown
+
+# Ship 安装
+
+Ship 的项目安装包名为 `chreode-ship`，主安装渠道是 PyPI，使用 `uvx` 运行一次性项目安装器。
+[GitHub Releases](https://github.com/Chreode/ship/releases) 保存版本说明及同批 wheel、sdist 和 `SHA256SUMS`，
+用于校验、归档和备用安装；用户安装无需注册 PyPI 账号。
+本文使用 `@latest` 请求最新发布的安装器；需要复现指定版本时，将 `latest` 换成目标版本号。
+可用版本见 [PyPI 项目页](https://pypi.org/project/chreode-ship/)，未发布的源码可用文末的本地构建验证。
+
+## 安装
+
+需要已有的 [uv](https://docs.astral.sh/uv/getting-started/installation/)。运行时需要 Python 3.11+，uv 可按需自动获取；
+不允许自动下载时在 `uvx` 后加 `--no-python-downloads`，并预先准备兼容 Python。
+在要使用 Ship 的项目根目录运行；也可用 `--project /绝对路径` 指定目标。Git 项目须指向仓库或 worktree 根目录。
+命令会下载包及依赖、使用 uv 缓存，并立即写入所选组件的项目文件；不另弹确认。
+
+```bash
+uvx chreode-ship@latest install ship
+```
+
+Codex 是默认宿主；Claude Code 用户追加 `--host claude`。安装后在目标项目新开任务，核对实际加载的技能路径。
+
+三个组件独立安装：
+
+| 组件 | 内容 |
+| --- | --- |
+| `ship` | 五种职责 Skill、CI 反馈 Skill、Python waiter、共享合同及宿主角色配置 |
+| `ship-feedback` | 生成汇总当前 PR 检查的 workflow，向 Writer 返回 CI 失败或通过结果 |
+| `codex-review-gate` | 生成独立的 Codex Review Gate workflow，只检查 Codex 审查反馈 |
+
+需要 GitHub CI 反馈时，在同一项目追加：
+
+```bash
+uvx chreode-ship@latest install ship-feedback
+```
+
+将生成的 `.github/workflows/ship-feedback.yml` 提交并合入默认分支后才会生效。它使用 GitHub Actions 自带的
+`GITHUB_TOKEN`，无需新 App 或 Secret；已出现的测试失败会先返回，即使 Codex 未触发或仍在等待。
+反馈不解析 Codex 评论、不请求模型，不应设为 required check；反馈通过后仍需满足项目的原生合并保护。
+
+需要独立 Codex Gate 时，运行：
+
+```bash
+uvx chreode-ship@latest install codex-review-gate
+```
+
+它只生成接入文件，并输出与已安装 Action 完整 SHA 对应的 Gate 采用说明 URL。仓库管理员按该固定版本说明
+配置 App、凭据和合并规则，再提交 workflow；安装器不会执行这些平台操作，也不会发起 `@codex review`。
+`install gate` 是兼容别名；`install all` 是三项并集，三个组件也可按任意顺序分别安装。
+
+## 写入范围与模型配置
+
+| 项目内路径 | 写入内容 |
+| --- | --- |
+| `.ship/` | 许可证、安装记录；选择 `ship` 时还包括合同、角色默认配置和 waiter |
+| `.agents/skills/ship-*/` | Codex 的六份 Skill |
+| `.codex/agents/{writer,researcher,verifier,reviewer}.toml` | Codex 四个子角色配置 |
+| `.codex/config.toml` | 需要时把 `agents.max_depth` 补为至少 `2`，保留其他配置 |
+| `.claude/skills/ship-*/` | Claude Code 的六份 Skill，替代 Codex 专用资源 |
+| `.github/workflows/ship-feedback.yml` | 仅选择 `ship-feedback` 或 `all` 时生成 |
+| `.github/workflows/codex-check.yml` | 仅选择 `codex-review-gate` 或 `all` 时生成 |
+
+Git 项目通过实际 `info/exclude` 精确忽略安装器拥有的本地资源；不忽略整个 `.agents/` 或 `.codex/`，
+不改 `.gitignore`，不 untrack 既有文件，两种 workflow 保持可提交。worktree 可能共用主仓的 Git exclude。
+安装器不创建或修改项目的 `AGENTS.md`、`CLAUDE.md`、`CODEOWNERS`，遇到同名资源或受管理配置冲突时停止。
+
+直接编辑项目 `.codex/agents/对应角色.toml` 的 `model` 和 `model_reasoning_effort`：
+
+| 角色 | 默认模型 | 默认 effort |
+| --- | --- | --- |
+| Writer | `gpt-5.6-sol` | `medium` |
+| Reviewer | `gpt-5.6-sol` | `high` |
+| Researcher、Verifier | `gpt-5.6-terra` | `medium` |
+
+同版本重复安装保留这两个字段，其余字段由安装器管理；卸载会移除角色配置及其中的模型设置。
+单次任务选择优先，配置的模型须由宿主支持。Commander 沿用顶层任务的设置；其他宿主使用其原生模型配置。
+具体选择规则见安装后的 `.agents/skills/ship-commander/SKILL.md`；Claude Code 宿主读取对应的
+`.claude/skills/ship-commander/SKILL.md`。
+
+项目安装器不操作全局 Plugin，也不改用户级 Skill、项目信任、沙箱或账号权限。若以前通过宿主插件管理
+安装过 Ship，那份历史安装的升级和卸载仍由宿主管理；先确认其来源和版本，避免重复加载。
+uv 的项目外缓存可用 `uv cache dir` 查看，项目卸载不会清除它。
+
+## 查看、卸载与升级
+
+在已安装 Ship 的项目目录运行：
+
+```bash
+uvx chreode-ship@latest files
+uvx chreode-ship@latest uninstall
+```
+
+`files` 查看已安装清单；`uninstall` 先检查冲突，再恢复原有配置并移除自己的文件和 Git 忽略区块。
+它不会撤销远端 workflow、App、Environment 或 Ruleset。安装记录位于 `.ship/install.toml`；
+兼容的旧安装记录可以由新安装器处理。若安装器报告状态版本或 schema 不受支持，不要手改 receipt；使用
+该记录对应的原发行名、版本和可信 wheel 执行 `files`、`uninstall`，再安装目标版本。
+内部 Python 模块仍叫 `keel_ship`，它不是用户安装时输入的包名。
+
+尚未发布时，可在 Ship 源码目录构建本地 wheel，再指定另一个目标项目验证：
+
+```bash
+uv build --wheel
+```
+
+从 `dist/` 选择本次构建生成的 wheel，将下列占位路径替换为该文件的完整路径：
+
+```bash
+uvx --isolated --no-python-downloads --from '/abs/path/to/chreode_ship-<version>-py3-none-any.whl' chreode-ship install ship --project /abs/project
+```
+
+GitHub Release 附件也可作备用来源：从目标版本的 Release 页面下载 wheel 并核对 `SHA256SUMS`，
+再将该文件路径传给上述 `--from`。Release 说明中的安装命令会固定到该次发布版本。
+这是同一个项目安装器，不是另一套宿主安装方式。
+
+完全离线安装还需提前准备 uv、兼容 Python、wheel 及其依赖；只下载 Ship wheel 并不等于依赖已齐备。

chreode_ship-0.8.2.dist-info/RECORD

@@ -0,0 +1,25 @@
+keel_ship/__init__.py,sha256=Lqi_iDkrVMQskSkekWfPcWzHK9St9nz_ZcS2WdTJKxU,95
+keel_ship/cli.py,sha256=_7eVzNpPl4RPMQE0T2CpLYoG-G5KDocHO42zYYs5rfU,2863
+keel_ship/installer.py,sha256=ZGTfSW_KSDdpDsMBmmeDFw52HTfttPFWpOJpX8LzdsA,37233
+keel_ship/resources/LICENSE,sha256=8644tMUhLSc1wAQ5ZhNzIZImmc53YJIgKf69lqy4nps,1074
+keel_ship/resources/actions/codex-review-gate/consumer-workflow.yml,sha256=jftxOZ3F_0wlK_-feAO0dIv1gXYCS3_pFiuq9c6X2ns,1003
+keel_ship/resources/actions/ship-feedback/consumer-workflow.yml,sha256=OejHOzY5K3N_PM6yqF-JnNCpJZq2oKFNbtNR-YUDp7s,1764
+keel_ship/resources/plugin/ship/contract.md,sha256=y8i9Bxg-TUQbQn8righmZ1m_KLZHt2bzsip9b2xCd-E,4875
+keel_ship/resources/plugin/ship/feedback.md,sha256=RRNe922dm1p9NFgsQIXlhoxvwV2iZsJXH7Z3hXTAwxM,4695
+keel_ship/resources/actions/ship-feedback/scripts/publisher.py,sha256=muMOSO0K6LVW9BmIjGbEhpR1_qbv3NMqsqBirzzaU60,26573
+keel_ship/resources/plugin/ship/agents/researcher.toml,sha256=eF2SaguJU-a0U6XsicirRWcAMilhNKWfT9dYT75u6TM,694
+keel_ship/resources/plugin/ship/agents/reviewer.toml,sha256=ZmhsQsE768W93qRl1XrpolKbNJvNtFN3eIS4yjHNlaU,689
+keel_ship/resources/plugin/ship/agents/verifier.toml,sha256=V02P_r2vgJJ1s1mYXHtsDA2MtFndSAdH4orDE_S3bEw,694
+keel_ship/resources/plugin/ship/agents/writer.toml,sha256=RArRsLNNZFrbZYsWHa8TjuGXRQTpX2YPHL5jOLTWZv4,753
+keel_ship/resources/plugin/ship/scripts/wait_check.py,sha256=V94v1yulDZRyhM5ExQbvqNiwjh5NtrGQEz-LHRYpNSM,20721
+keel_ship/resources/plugin/ship/skills/ship-commander/SKILL.md,sha256=dweIM583x9DEAqzr24S2HSa76avaKL3GhZKdO6fnHz4,4884
+keel_ship/resources/plugin/ship/skills/ship-feedback/SKILL.md,sha256=2BJw4qwRYhYQNCM3ojdDu4lKhya3EfeqJNPM6a-TqKk,2533
+keel_ship/resources/plugin/ship/skills/ship-researcher/SKILL.md,sha256=S5U0ywrW6u_UvVm5qZQW2Z1I3boVhMxSIP6s01ewqR0,1703
+keel_ship/resources/plugin/ship/skills/ship-reviewer/SKILL.md,sha256=xSVMobLwOUkKtKSkcDnVafq-TtCLVe0ohxUKSF2KQBA,3057
+keel_ship/resources/plugin/ship/skills/ship-verifier/SKILL.md,sha256=a2kJz1y7lHUu94CIOpUz6HWCRlhaEBH_k8Qvxq7M_0Q,1724
+keel_ship/resources/plugin/ship/skills/ship-worker/SKILL.md,sha256=kHiPRnrdDooe6YvWTXtPr2Uap4WAlH08tjIqNrjZYCs,5828
+chreode_ship-0.8.2.dist-info/METADATA,sha256=Ni8BMQfN2WrFVxA7cnY7NA11s44_57jxZ8Z2gqgDZ-E,6882
+chreode_ship-0.8.2.dist-info/WHEEL,sha256=THafob7ofN-NsuMN7Mg4qZyHaQI7KkD-QlcQatYhXPo,87
+chreode_ship-0.8.2.dist-info/entry_points.txt,sha256=bAnBSS7p8HwlkzqRvNcJVxoX_8m0zeZG2hi_KB_CZCw,52
+chreode_ship-0.8.2.dist-info/licenses/LICENSE,sha256=8644tMUhLSc1wAQ5ZhNzIZImmc53YJIgKf69lqy4nps,1074
+chreode_ship-0.8.2.dist-info/RECORD,,

chreode_ship-0.8.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.3
+Root-Is-Purelib: true
+Tag: py3-none-any

chreode_ship-0.8.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+chreode-ship = keel_ship.cli:main

chreode_ship-0.8.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ship contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

keel_ship/__init__.py

@@ -0,0 +1,5 @@
+"""Project-local installer for Ship."""
+
+from .installer import VERSION
+
+__all__ = ["VERSION"]

keel_ship/cli.py

@@ -0,0 +1,67 @@
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+from .installer import InstallError, install, managed_files, uninstall
+
+
+def parser() -> argparse.ArgumentParser:
+    value = argparse.ArgumentParser(prog="chreode-ship")
+    subcommands = value.add_subparsers(dest="command", required=True)
+    install_command = subcommands.add_parser(
+        "install", help="install project skills, CI feedback workflow, Codex Review Gate, or all three"
+    )
+    install_command.add_argument("component", choices=("ship", "ship-feedback", "codex-review-gate", "gate", "all"))
+    install_command.add_argument(
+        "--project",
+        type=Path,
+        default=Path.cwd(),
+        help="target directory (must be the repository or linked-worktree root for Git)",
+    )
+    install_command.add_argument("--host", choices=("codex", "claude"), default="codex")
+    for name, help_text in (
+        ("files", "list files owned by this project's chreode-ship installation"),
+        ("uninstall", "remove this project's chreode-ship installation"),
+    ):
+        command = subcommands.add_parser(name, help=help_text)
+        command.add_argument(
+            "--project",
+            type=Path,
+            default=Path.cwd(),
+            help="target directory (must be the repository or linked-worktree root for Git)",
+        )
+    return value
+
+
+def main() -> int:
+    arguments = parser().parse_args()
+    try:
+        if arguments.command == "files":
+            for kind, path in managed_files(project=arguments.project):
+                suffix = " (chreode-ship only owns this project's marked block)" if kind == "git-exclude-block" else ""
+                print(f"{kind}\t{path}{suffix}")
+            return 0
+        if arguments.command == "uninstall":
+            project, _ = uninstall(project=arguments.project)
+            print(f"chreode-ship: uninstalled project integration from {project}")
+            return 0
+        result = install(project=arguments.project, requested=arguments.component, host=arguments.host)
+    except InstallError as error:
+        print(f"chreode-ship: {error}", file=sys.stderr)
+        return 2
+    status = "unchanged" if not result.changed else "installed"
+    components = ", ".join(result.components)
+    print(f"chreode-ship: {status} {components} in {result.project}")
+    if "ship" in result.components:
+        print("Ship 项目技能与模型配置已就绪；GitHub CI 反馈通过 install ship-feedback 独立接入。")
+    if "ship-feedback" in result.components:
+        print("Ship CI 反馈：将 .github/workflows/ship-feedback.yml 接入默认分支后，Writer 等待 ship-feedback。")
+    if result.gate_setup_url is not None:
+        print(f"Codex Review Gate setup: {result.gate_setup_url}")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())