wellbore-cli 0.1.0__tar.gz

wellbore_cli-0.1.0/LICENSE

@@ -0,0 +1,133 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+Required Notice: Copyright (c) 2026 elf004-star
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose.  However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software.  Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or religious
+observance, without any anticipated commercial application,
+is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization,
+or government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting
+from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else.  These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice.  Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization.  **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

wellbore_cli-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/wellbore_cli/skills *.md *.yaml

wellbore_cli-0.1.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: wellbore-cli
+Version: 0.1.0
+Summary: A lightweight REST client and progressive-disclosure skill for Wellbore Studio
+Author-email: elf004-star <1873475824@qq.com>
+License-Expression: PolyForm-Noncommercial-1.0.0
+Project-URL: Homepage, https://github.com/elf004-star/drilling-agent-skills
+Project-URL: Repository, https://github.com/elf004-star/drilling-agent-skills
+Project-URL: Issues, https://github.com/elf004-star/drilling-agent-skills/issues
+Project-URL: Documentation, https://github.com/elf004-star/drilling-agent-skills/blob/main/docs/architecture.md
+Keywords: wellbore,drilling,well-structure,petroleum,geology,cli,rest-client,agent-skill
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# wellbore
+
+井身结构图服务的轻量客户端。Python 3.11+，运行时零第三方依赖，无需安装 matplotlib、字体或服务端代码。内置中文命令帮助、YAML 模板和按需加载的 Codex skill。
+
+## 安装
+
+从 PyPI 安装（推荐用 [uv](https://docs.astral.sh/uv/getting-started/installation/) 装成隔离的命令行工具）：
+
+```sh
+uv tool install wellbore-cli
+wellbore --help
+```
+
+`pipx install wellbore-cli` 或 `pip install wellbore-cli` 等价。
+
+从源码安装（开发本仓库或使用未发布版本时）：
+
+```sh
+uv tool install --python 3.11 'git+https://github.com/elf004-star/drilling-agent-skills.git'
+uv tool install --python 3.11 .
+# 或不全局安装
+uv run --python 3.11 wellbore --help
+```
+
+## 五分钟上手
+
+```sh
+wellbore auth set                     # 隐藏输入 API Key，本机保存
+wellbore health
+wellbore quota
+wellbore template straight -o well.yaml
+# 编辑 well.yaml，替换示例井数据
+wellbore validate well.yaml
+wellbore render well.yaml -o output
+```
+
+输出保存到 `output/<archive_id>/`，包括图片、服务实际生成的 CSV 等文件和规范化输入 `well_data.yaml`。保留服务 warnings；不要把示例数据当作用户的实际井数据。
+
+临时密钥推荐通过 `WELLBORE_API_KEY` 环境变量或 `--key-file /path/to/key` 传入。避免把密钥直接写在命令行、URL、脚本或仓库。`auth clear` 仅删除本机存储；撤销 Key 在服务网页完成。POSIX 保存文件权限为 0600；Windows 应使用受保护的用户配置目录。
+
+基地址默认 `https://ccqwell.vip.cpolar.cn`，可运行 `wellbore config set-url https://your-service.example`。优先级：`--base-url` > `WELLBORE_BASE_URL` > 配置 > 默认值；密钥优先级：显式 `--key-file` > `WELLBORE_API_KEY` > 保存文件。`WELLBORE_CONFIG_DIR` 可隔离多个使用环境。
+
+## 分步操作与脚本
+
+```sh
+wellbore normalize well.yaml -o normalized.json
+wellbore jobs submit well.yaml --image-format svg --json
+wellbore jobs status JOB_ID --json
+wellbore jobs wait JOB_ID --wait-timeout 300 --json
+wellbore jobs events JOB_ID --json       # JSON Lines，每行一个完整快照
+wellbore history --json
+wellbore download ARCHIVE_ID --file well_structure_plot.svg -o figure.svg
+wellbore download ARCHIVE_ID -o archive.zip
+wellbore render well.yaml --edit ARCHIVE_ID --name '测试井' -o output
+cat well.yaml | wellbore validate - --input-format yaml --json
+```
+
+所有命令支持 `--json`、`--base-url`、`--key-file`、`--timeout`、`--no-proxy`。普通命令的 stdout 是单份 JSON；进度和错误走 stderr；模板与 normalize 可直接输出输入文本。`jobs events --json` 为 JSON Lines。现有文件默认拒绝覆盖，显式 `--force` 才替换；下载按文件原子落盘，中断不留下半份最终文件。不自动解压 ZIP。
+
+退出码：0 成功，1 HTTP/服务问题，2 用法/本地输入/文件问题，3 凭据问题，4 网络/客户端等待超时，5 任务 failed/cancelled，130 用户中断。查询成功但任务失败也退出 5。argparse 用法错误使用标准 stderr 提示。
+
+REST 提交没有幂等键：客户端不会自动重试提交。POST 超时或断连后先查 `history`，避免重复绘图与扣额度。已知 ID 的任务可用 `jobs wait` 恢复；任务状态 404 可能是服务重启/状态淘汰，先检查历史。等待超时/中断不会取消服务端任务。HTTP 仅允许 localhost 开发，重定向被拒绝以避免转发密钥。
+
+代理遵循系统/环境配置，HTTPS 使用 `HTTPS_PROXY`；如果本机旧代理不可用，用 `--no-proxy`。本地可用代理示例为 `http://127.0.0.1:8118`。标准库传输不直接支持 SOCKS。
+
+## 安装 skill
+
+```sh
+wellbore skill install
+# 指定其他技能根目录
+wellbore skill install --dir /path/to/skills
+wellbore skill path
+```
+
+安装复制到 `<dir>/wellbore`，已有目录拒绝覆盖。重新加载技能后调用 `$wellbore`。仓库入口为 [src/wellbore_cli/skills/wellbore/SKILL.md](https://github.com/elf004-star/drilling-agent-skills/blob/main/src/wellbore_cli/skills/wellbore/SKILL.md)，该目录是唯一来源，随 wheel 打包。根目录不再放指向它的短路径软链接：Windows 检出时软链接退化为内容是路径文本的普通文件，`skills/...` 打不开，而 ZIP 下载与网页浏览本来就无法还原软链接，跨平台行为不一致。技能只按任务需要加载安装、命令、领域、恢复与 API 边界参考。
+
+## 开发与验证
+
+```sh
+uv run --python 3.11 python -m unittest discover -s tests -v
+uv build
+```
+
+详见 [架构说明](https://github.com/elf004-star/drilling-agent-skills/blob/main/docs/architecture.md)、[领域上下文](https://github.com/elf004-star/drilling-agent-skills/blob/main/CONTEXT.md) 和 [契约快照](https://github.com/elf004-star/drilling-agent-skills/blob/main/docs/api-contract.md)。线上来源为 [API 文档](https://ccqwell.vip.cpolar.cn/docs) 与 `/openapi.json`。不提供需要网页会话的注册、账户管理、Key 管理或管理员命令；REST 文档没有公开取消端点，因此不伪造取消命令。
+
+## 许可
+
+[PolyForm Noncommercial License 1.0.0](https://github.com/elf004-star/drilling-agent-skills/blob/main/LICENSE) —— 允许个人、研究、教育机构、慈善与政府用途，**禁止商业用途**；商用需另行取得授权。这不是 OSI 认可的开源许可证。
+
+Required Notice: Copyright (c) 2026 elf004-star

wellbore_cli-0.1.0/README.md

@@ -0,0 +1,90 @@
+# wellbore
+
+井身结构图服务的轻量客户端。Python 3.11+，运行时零第三方依赖，无需安装 matplotlib、字体或服务端代码。内置中文命令帮助、YAML 模板和按需加载的 Codex skill。
+
+## 安装
+
+从 PyPI 安装（推荐用 [uv](https://docs.astral.sh/uv/getting-started/installation/) 装成隔离的命令行工具）：
+
+```sh
+uv tool install wellbore-cli
+wellbore --help
+```
+
+`pipx install wellbore-cli` 或 `pip install wellbore-cli` 等价。
+
+从源码安装（开发本仓库或使用未发布版本时）：
+
+```sh
+uv tool install --python 3.11 'git+https://github.com/elf004-star/drilling-agent-skills.git'
+uv tool install --python 3.11 .
+# 或不全局安装
+uv run --python 3.11 wellbore --help
+```
+
+## 五分钟上手
+
+```sh
+wellbore auth set                     # 隐藏输入 API Key，本机保存
+wellbore health
+wellbore quota
+wellbore template straight -o well.yaml
+# 编辑 well.yaml，替换示例井数据
+wellbore validate well.yaml
+wellbore render well.yaml -o output
+```
+
+输出保存到 `output/<archive_id>/`，包括图片、服务实际生成的 CSV 等文件和规范化输入 `well_data.yaml`。保留服务 warnings；不要把示例数据当作用户的实际井数据。
+
+临时密钥推荐通过 `WELLBORE_API_KEY` 环境变量或 `--key-file /path/to/key` 传入。避免把密钥直接写在命令行、URL、脚本或仓库。`auth clear` 仅删除本机存储；撤销 Key 在服务网页完成。POSIX 保存文件权限为 0600；Windows 应使用受保护的用户配置目录。
+
+基地址默认 `https://ccqwell.vip.cpolar.cn`，可运行 `wellbore config set-url https://your-service.example`。优先级：`--base-url` > `WELLBORE_BASE_URL` > 配置 > 默认值；密钥优先级：显式 `--key-file` > `WELLBORE_API_KEY` > 保存文件。`WELLBORE_CONFIG_DIR` 可隔离多个使用环境。
+
+## 分步操作与脚本
+
+```sh
+wellbore normalize well.yaml -o normalized.json
+wellbore jobs submit well.yaml --image-format svg --json
+wellbore jobs status JOB_ID --json
+wellbore jobs wait JOB_ID --wait-timeout 300 --json
+wellbore jobs events JOB_ID --json       # JSON Lines，每行一个完整快照
+wellbore history --json
+wellbore download ARCHIVE_ID --file well_structure_plot.svg -o figure.svg
+wellbore download ARCHIVE_ID -o archive.zip
+wellbore render well.yaml --edit ARCHIVE_ID --name '测试井' -o output
+cat well.yaml | wellbore validate - --input-format yaml --json
+```
+
+所有命令支持 `--json`、`--base-url`、`--key-file`、`--timeout`、`--no-proxy`。普通命令的 stdout 是单份 JSON；进度和错误走 stderr；模板与 normalize 可直接输出输入文本。`jobs events --json` 为 JSON Lines。现有文件默认拒绝覆盖，显式 `--force` 才替换；下载按文件原子落盘，中断不留下半份最终文件。不自动解压 ZIP。
+
+退出码：0 成功，1 HTTP/服务问题，2 用法/本地输入/文件问题，3 凭据问题，4 网络/客户端等待超时，5 任务 failed/cancelled，130 用户中断。查询成功但任务失败也退出 5。argparse 用法错误使用标准 stderr 提示。
+
+REST 提交没有幂等键：客户端不会自动重试提交。POST 超时或断连后先查 `history`，避免重复绘图与扣额度。已知 ID 的任务可用 `jobs wait` 恢复；任务状态 404 可能是服务重启/状态淘汰，先检查历史。等待超时/中断不会取消服务端任务。HTTP 仅允许 localhost 开发，重定向被拒绝以避免转发密钥。
+
+代理遵循系统/环境配置，HTTPS 使用 `HTTPS_PROXY`；如果本机旧代理不可用，用 `--no-proxy`。本地可用代理示例为 `http://127.0.0.1:8118`。标准库传输不直接支持 SOCKS。
+
+## 安装 skill
+
+```sh
+wellbore skill install
+# 指定其他技能根目录
+wellbore skill install --dir /path/to/skills
+wellbore skill path
+```
+
+安装复制到 `<dir>/wellbore`，已有目录拒绝覆盖。重新加载技能后调用 `$wellbore`。仓库入口为 [src/wellbore_cli/skills/wellbore/SKILL.md](https://github.com/elf004-star/drilling-agent-skills/blob/main/src/wellbore_cli/skills/wellbore/SKILL.md)，该目录是唯一来源，随 wheel 打包。根目录不再放指向它的短路径软链接：Windows 检出时软链接退化为内容是路径文本的普通文件，`skills/...` 打不开，而 ZIP 下载与网页浏览本来就无法还原软链接，跨平台行为不一致。技能只按任务需要加载安装、命令、领域、恢复与 API 边界参考。
+
+## 开发与验证
+
+```sh
+uv run --python 3.11 python -m unittest discover -s tests -v
+uv build
+```
+
+详见 [架构说明](https://github.com/elf004-star/drilling-agent-skills/blob/main/docs/architecture.md)、[领域上下文](https://github.com/elf004-star/drilling-agent-skills/blob/main/CONTEXT.md) 和 [契约快照](https://github.com/elf004-star/drilling-agent-skills/blob/main/docs/api-contract.md)。线上来源为 [API 文档](https://ccqwell.vip.cpolar.cn/docs) 与 `/openapi.json`。不提供需要网页会话的注册、账户管理、Key 管理或管理员命令；REST 文档没有公开取消端点，因此不伪造取消命令。
+
+## 许可
+
+[PolyForm Noncommercial License 1.0.0](https://github.com/elf004-star/drilling-agent-skills/blob/main/LICENSE) —— 允许个人、研究、教育机构、慈善与政府用途，**禁止商业用途**；商用需另行取得授权。这不是 OSI 认可的开源许可证。
+
+Required Notice: Copyright (c) 2026 elf004-star

wellbore_cli-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "wellbore-cli"
+version = "0.1.0"
+description = "A lightweight REST client and progressive-disclosure skill for Wellbore Studio"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = []
+license = "PolyForm-Noncommercial-1.0.0"
+license-files = ["LICENSE"]
+authors = [{ name = "elf004-star", email = "1873475824@qq.com" }]
+keywords = [
+    "wellbore",
+    "drilling",
+    "well-structure",
+    "petroleum",
+    "geology",
+    "cli",
+    "rest-client",
+    "agent-skill",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+]
+
+[project.urls]
+Homepage = "https://github.com/elf004-star/drilling-agent-skills"
+Repository = "https://github.com/elf004-star/drilling-agent-skills"
+Issues = "https://github.com/elf004-star/drilling-agent-skills/issues"
+Documentation = "https://github.com/elf004-star/drilling-agent-skills/blob/main/docs/architecture.md"
+
+[project.scripts]
+wellbore = "wellbore_cli.cli:main"
+
+[tool.setuptools]
+include-package-data = false
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["wellbore_cli*"]
+namespaces = false
+
+[tool.setuptools.package-data]
+wellbore_cli = ["skills/wellbore/SKILL.md", "skills/wellbore/agents/*.yaml", "skills/wellbore/references/*.md", "skills/wellbore/assets/*.yaml"]

wellbore_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

wellbore_cli-0.1.0/src/wellbore_cli/__init__.py

@@ -0,0 +1,2 @@
+"""Wellbore Studio HTTP client. No rendering dependencies required."""
+__version__ = "0.1.0"

wellbore_cli-0.1.0/src/wellbore_cli/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+raise SystemExit(main())