ChatQPet 0.0.1__tar.gz

chatqpet-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ChatArch
+
+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.

chatqpet-0.0.1/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: ChatQPet
+Version: 0.0.1
+Summary: ChatQPet: ChatArch QPet command-line package.
+Author-email: ChatArch <1073853456@qq.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ChatArch/ChatQPet
+Project-URL: Repository, https://github.com/ChatArch/ChatQPet
+Project-URL: Documentation, https://arch.gh.wzhecnu.cn/ChatQPet/
+Keywords: chatqpet,chatarch,cli
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click<9.0,>=8.0
+Requires-Dist: chatstyle<0.3.0,>=0.2.0
+Requires-Dist: chatenv<0.3.0,>=0.2.10
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs<2.0,>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material<9.7,>=9.5; extra == "docs"
+Requires-Dist: mkdocs-static-i18n<2.0,>=1.2; extra == "docs"
+Requires-Dist: mike<3.0,>=2.0; extra == "docs"
+Dynamic: license-file
+
+<div align="center">
+    <a href="https://pypi.python.org/pypi/ChatQPet">
+        <img src="https://img.shields.io/pypi/v/ChatQPet.svg" alt="PyPI version" />
+    </a>
+    <a href="https://github.com/ChatArch/ChatQPet/actions/workflows/ci.yml">
+        <img src="https://github.com/ChatArch/ChatQPet/actions/workflows/ci.yml/badge.svg" alt="Tests" />
+    </a>
+    <a href="https://arch.gh.wzhecnu.cn/ChatQPet/">
+        <img src="https://img.shields.io/badge/docs-mkdocs-blue.svg" alt="Documentation" />
+    </a>
+</div>
+
+<div align="center">
+
+[英文版](README.en.md) | [简体中文](README.md)
+</div>
+
+# ChatQPet
+
+ChatQPet: ChatArch QPet command-line package.
+
+
+文档入口：<https://arch.gh.wzhecnu.cn/ChatQPet/>
+
+按场景选择文档：
+
+| 场景 | 文档 |
+| --- | --- |
+| 第一次安装、运行命令行、确认包可用 | [CLI 树](docs/cli-tree.md) |
+| 校对当前包有哪些一等能力和边界 | [能力地图](docs/capability-map.md) |
+| 从 Python 代码调用包能力 | [接口树](docs/interface-tree.md) |
+
+## 快速开始
+
+```bash
+pip install ChatQPet
+chatqpet --help
+chatqpet --version
+chatqpet --tree
+chatqpet --tree-brief
+```
+
+开发环境：
+
+```bash
+pip install -e ".[dev,docs]"
+python -m pytest -q
+mkdocs build --strict
+python -m build
+```
+
+## 命令行规范
+
+这个占位包依赖 `chatstyle>=0.2.0,<0.3.0` 和 `chatenv>=0.2.10,<0.3.0`：
+
+- `add_tree_option()` 从真实 Click 注册面提供 `--tree` / `--tree-brief`。
+- `CommandSchema` / `CommandField` 描述输入。
+- `add_interactive_option()` 提供统一 `-i/-I`。
+- `resolve_command_inputs()` 统一缺参补问、默认值、TTY 与校验。
+- 默认生成 `config.py` 和 `chatenv.configs` 入口点，使包可被 ChatEnv 发现；只有明确不需要 ChatEnv 接入时才使用 `--without-chatenv-provider`。
+
+## 目录结构
+
+- `src/`：包源码
+- `tests/code-tests/`：代码测试和历史测试迁移
+- `tests/cli-tests/`：真实 CLI 测试，doc-first
+- `tests/mock-cli-tests/`：mock/fake CLI 测试，doc-first
+- `docs/`：长期维护文档，由 mkdocs 构建
+
+## 开发说明
+
+扩展脚手架前，先阅读 `DEVELOP.md` 和 `AGENTS.md`。

chatqpet-0.0.1/README.md

@@ -0,0 +1,72 @@
+<div align="center">
+    <a href="https://pypi.python.org/pypi/ChatQPet">
+        <img src="https://img.shields.io/pypi/v/ChatQPet.svg" alt="PyPI version" />
+    </a>
+    <a href="https://github.com/ChatArch/ChatQPet/actions/workflows/ci.yml">
+        <img src="https://github.com/ChatArch/ChatQPet/actions/workflows/ci.yml/badge.svg" alt="Tests" />
+    </a>
+    <a href="https://arch.gh.wzhecnu.cn/ChatQPet/">
+        <img src="https://img.shields.io/badge/docs-mkdocs-blue.svg" alt="Documentation" />
+    </a>
+</div>
+
+<div align="center">
+
+[英文版](README.en.md) | [简体中文](README.md)
+</div>
+
+# ChatQPet
+
+ChatQPet: ChatArch QPet command-line package.
+
+
+文档入口：<https://arch.gh.wzhecnu.cn/ChatQPet/>
+
+按场景选择文档：
+
+| 场景 | 文档 |
+| --- | --- |
+| 第一次安装、运行命令行、确认包可用 | [CLI 树](docs/cli-tree.md) |
+| 校对当前包有哪些一等能力和边界 | [能力地图](docs/capability-map.md) |
+| 从 Python 代码调用包能力 | [接口树](docs/interface-tree.md) |
+
+## 快速开始
+
+```bash
+pip install ChatQPet
+chatqpet --help
+chatqpet --version
+chatqpet --tree
+chatqpet --tree-brief
+```
+
+开发环境：
+
+```bash
+pip install -e ".[dev,docs]"
+python -m pytest -q
+mkdocs build --strict
+python -m build
+```
+
+## 命令行规范
+
+这个占位包依赖 `chatstyle>=0.2.0,<0.3.0` 和 `chatenv>=0.2.10,<0.3.0`：
+
+- `add_tree_option()` 从真实 Click 注册面提供 `--tree` / `--tree-brief`。
+- `CommandSchema` / `CommandField` 描述输入。
+- `add_interactive_option()` 提供统一 `-i/-I`。
+- `resolve_command_inputs()` 统一缺参补问、默认值、TTY 与校验。
+- 默认生成 `config.py` 和 `chatenv.configs` 入口点，使包可被 ChatEnv 发现；只有明确不需要 ChatEnv 接入时才使用 `--without-chatenv-provider`。
+
+## 目录结构
+
+- `src/`：包源码
+- `tests/code-tests/`：代码测试和历史测试迁移
+- `tests/cli-tests/`：真实 CLI 测试，doc-first
+- `tests/mock-cli-tests/`：mock/fake CLI 测试，doc-first
+- `docs/`：长期维护文档，由 mkdocs 构建
+
+## 开发说明
+
+扩展脚手架前，先阅读 `DEVELOP.md` 和 `AGENTS.md`。

chatqpet-0.0.1/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ChatQPet"
+dynamic = ["version"]
+description = "ChatQPet: ChatArch QPet command-line package."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+dependencies = ["click>=8.0,<9.0", "chatstyle>=0.2.0,<0.3.0", "chatenv>=0.2.10,<0.3.0"]
+authors = [{name = "ChatArch", email = "1073853456@qq.com"}]
+keywords = ["chatqpet", "chatarch", "cli"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/ChatArch/ChatQPet"
+Repository = "https://github.com/ChatArch/ChatQPet"
+Documentation = "https://arch.gh.wzhecnu.cn/ChatQPet/"
+
+[project.scripts]
+chatqpet = "chatqpet.cli:main"
+
+[project.entry-points."chatenv.configs"]
+chatqpet = "chatqpet.config"
+
+[project.optional-dependencies]
+dev = ["build", "pytest", "twine"]
+docs = ["mkdocs>=1.6,<2.0", "mkdocs-material>=9.5,<9.7", "mkdocs-static-i18n>=1.2,<2.0", "mike>=2.0,<3.0"]
+
+[tool.setuptools.dynamic]
+version = {attr = "chatqpet.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools]
+include-package-data = true

chatqpet-0.0.1/setup.cfg

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

chatqpet-0.0.1/src/ChatQPet.egg-info/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: ChatQPet
+Version: 0.0.1
+Summary: ChatQPet: ChatArch QPet command-line package.
+Author-email: ChatArch <1073853456@qq.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ChatArch/ChatQPet
+Project-URL: Repository, https://github.com/ChatArch/ChatQPet
+Project-URL: Documentation, https://arch.gh.wzhecnu.cn/ChatQPet/
+Keywords: chatqpet,chatarch,cli
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click<9.0,>=8.0
+Requires-Dist: chatstyle<0.3.0,>=0.2.0
+Requires-Dist: chatenv<0.3.0,>=0.2.10
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs<2.0,>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material<9.7,>=9.5; extra == "docs"
+Requires-Dist: mkdocs-static-i18n<2.0,>=1.2; extra == "docs"
+Requires-Dist: mike<3.0,>=2.0; extra == "docs"
+Dynamic: license-file
+
+<div align="center">
+    <a href="https://pypi.python.org/pypi/ChatQPet">
+        <img src="https://img.shields.io/pypi/v/ChatQPet.svg" alt="PyPI version" />
+    </a>
+    <a href="https://github.com/ChatArch/ChatQPet/actions/workflows/ci.yml">
+        <img src="https://github.com/ChatArch/ChatQPet/actions/workflows/ci.yml/badge.svg" alt="Tests" />
+    </a>
+    <a href="https://arch.gh.wzhecnu.cn/ChatQPet/">
+        <img src="https://img.shields.io/badge/docs-mkdocs-blue.svg" alt="Documentation" />
+    </a>
+</div>
+
+<div align="center">
+
+[英文版](README.en.md) | [简体中文](README.md)
+</div>
+
+# ChatQPet
+
+ChatQPet: ChatArch QPet command-line package.
+
+
+文档入口：<https://arch.gh.wzhecnu.cn/ChatQPet/>
+
+按场景选择文档：
+
+| 场景 | 文档 |
+| --- | --- |
+| 第一次安装、运行命令行、确认包可用 | [CLI 树](docs/cli-tree.md) |
+| 校对当前包有哪些一等能力和边界 | [能力地图](docs/capability-map.md) |
+| 从 Python 代码调用包能力 | [接口树](docs/interface-tree.md) |
+
+## 快速开始
+
+```bash
+pip install ChatQPet
+chatqpet --help
+chatqpet --version
+chatqpet --tree
+chatqpet --tree-brief
+```
+
+开发环境：
+
+```bash
+pip install -e ".[dev,docs]"
+python -m pytest -q
+mkdocs build --strict
+python -m build
+```
+
+## 命令行规范
+
+这个占位包依赖 `chatstyle>=0.2.0,<0.3.0` 和 `chatenv>=0.2.10,<0.3.0`：
+
+- `add_tree_option()` 从真实 Click 注册面提供 `--tree` / `--tree-brief`。
+- `CommandSchema` / `CommandField` 描述输入。
+- `add_interactive_option()` 提供统一 `-i/-I`。
+- `resolve_command_inputs()` 统一缺参补问、默认值、TTY 与校验。
+- 默认生成 `config.py` 和 `chatenv.configs` 入口点，使包可被 ChatEnv 发现；只有明确不需要 ChatEnv 接入时才使用 `--without-chatenv-provider`。
+
+## 目录结构
+
+- `src/`：包源码
+- `tests/code-tests/`：代码测试和历史测试迁移
+- `tests/cli-tests/`：真实 CLI 测试，doc-first
+- `tests/mock-cli-tests/`：mock/fake CLI 测试，doc-first
+- `docs/`：长期维护文档，由 mkdocs 构建
+
+## 开发说明
+
+扩展脚手架前，先阅读 `DEVELOP.md` 和 `AGENTS.md`。

chatqpet-0.0.1/src/ChatQPet.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+src/ChatQPet.egg-info/PKG-INFO
+src/ChatQPet.egg-info/SOURCES.txt
+src/ChatQPet.egg-info/dependency_links.txt
+src/ChatQPet.egg-info/entry_points.txt
+src/ChatQPet.egg-info/requires.txt
+src/ChatQPet.egg-info/top_level.txt
+src/chatqpet/__init__.py
+src/chatqpet/cli.py
+src/chatqpet/config.py
+tests/test_cli.py
+tests/test_config.py
+tests/test_version.py
+tests/test_workflow_contract.py

chatqpet-0.0.1/src/ChatQPet.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

chatqpet-0.0.1/src/ChatQPet.egg-info/entry_points.txt

@@ -0,0 +1,5 @@
+[chatenv.configs]
+chatqpet = chatqpet.config
+
+[console_scripts]
+chatqpet = chatqpet.cli:main

chatqpet-0.0.1/src/ChatQPet.egg-info/requires.txt

@@ -0,0 +1,14 @@
+click<9.0,>=8.0
+chatstyle<0.3.0,>=0.2.0
+chatenv<0.3.0,>=0.2.10
+
+[dev]
+build
+pytest
+twine
+
+[docs]
+mkdocs<2.0,>=1.6
+mkdocs-material<9.7,>=9.5
+mkdocs-static-i18n<2.0,>=1.2
+mike<3.0,>=2.0

chatqpet-0.0.1/src/ChatQPet.egg-info/top_level.txt

@@ -0,0 +1 @@
+chatqpet

chatqpet-0.0.1/src/chatqpet/__init__.py

@@ -0,0 +1,5 @@
+"""ChatQPet package."""
+
+__all__ = ["__version__"]
+
+__version__ = "0.0.1"

chatqpet-0.0.1/src/chatqpet/cli.py

@@ -0,0 +1,26 @@
+"""CLI entrypoint for chatqpet."""
+
+from __future__ import annotations
+
+import click
+from chatstyle import add_tree_option
+
+from chatqpet import __version__
+
+
+@click.group(
+    name="chatqpet",
+    invoke_without_command=True,
+    no_args_is_help=True,
+)
+@click.version_option(__version__, prog_name="chatqpet")
+@add_tree_option(renderer_options={"root_name": "chatqpet"})
+def main() -> None:
+    """ChatQPet placeholder command-line interface."""
+    # Add package-specific commands here. Prefer ChatStyle helpers for
+    # interactive input when a command needs recoverable user input.
+    pass
+
+
+if __name__ == "__main__":
+    main()

chatqpet-0.0.1/src/chatqpet/config.py

@@ -0,0 +1,27 @@
+"Typed environment configuration for ChatQPet."
+
+from chatenv import BaseEnvConfig, EnvField
+
+
+class ChatQPetConfig(BaseEnvConfig):
+    "ChatQPet ChatEnv configuration."
+
+    _title = "ChatQPet Configuration"
+    _aliases = ["chatqpet"]
+    _storage_dir = "ChatQPet"
+
+    @classmethod
+    def test(cls) -> None:
+        """Validate schema registration without external side effects."""
+
+        print(f"Testing {cls._title}...")
+        print("Schema loaded; no network test is required.")
+
+    CHATQPET_API_KEY = EnvField(
+        "CHATQPET_API_KEY",
+        desc="API key",
+        is_sensitive=True,
+    )
+
+
+__all__ = ["ChatQPetConfig"]

chatqpet-0.0.1/tests/test_cli.py

@@ -0,0 +1,62 @@
+import click
+from click.testing import CliRunner
+from chatstyle import add_tree_option
+
+from chatqpet import __version__
+from chatqpet.cli import main
+
+
+def test_help_mentions_full_and_brief_tree_options():
+    result = CliRunner().invoke(main, ["--help"])
+
+    assert result.exit_code == 0
+    assert "--tree" in result.output
+    assert "--tree-brief" in result.output
+
+
+def test_version_option_reports_package_version():
+    result = CliRunner().invoke(main, ["--version"])
+
+    assert result.exit_code == 0
+    assert f"chatqpet, version {__version__}" in result.output
+
+
+def test_tree_reports_registered_root_only_surface():
+    result = CliRunner().invoke(main, ["--tree"])
+
+    assert result.exit_code == 0
+    assert result.output == (
+        "chatqpet\n"
+        "├── --help  # Show this message and exit.\n"
+        "├── --version  # Show the version and exit.\n"
+        "├── --tree  # Print the registered CLI tree and exit.\n"
+        "└── --tree-brief  # Print the registered CLI tree without parameter signatures and exit.\n"
+    )
+
+
+def test_tree_brief_reports_the_same_root_only_nodes():
+    full = CliRunner().invoke(main, ["--tree"])
+    brief = CliRunner().invoke(main, ["--tree-brief"])
+
+    assert brief.exit_code == 0
+    assert brief.output == full.output
+
+
+def test_tree_brief_omits_registered_command_signatures():
+    @click.group(name="sample")
+    @add_tree_option(renderer_options={"root_name": "sample"})
+    def sample() -> None:
+        """Sample commands."""
+
+    @sample.command()
+    @click.argument("path")
+    def inspect(path: str) -> None:
+        """Inspect a path."""
+
+    full = CliRunner().invoke(sample, ["--tree"])
+    brief = CliRunner().invoke(sample, ["--tree-brief"])
+
+    assert full.exit_code == brief.exit_code == 0
+    assert "inspect <PATH>" in full.output
+    assert "inspect  # Inspect a path." in brief.output
+    assert "<PATH>" not in brief.output

chatqpet-0.0.1/tests/test_config.py

@@ -0,0 +1,7 @@
+from chatqpet.config import ChatQPetConfig
+
+
+def test_chatenv_provider_metadata():
+    assert ChatQPetConfig._aliases == ["chatqpet"]
+    assert ChatQPetConfig._storage_dir == "ChatQPet"
+    assert ChatQPetConfig.CHATQPET_API_KEY.is_sensitive

chatqpet-0.0.1/tests/test_version.py

@@ -0,0 +1,5 @@
+from chatqpet import __version__
+
+
+def test_version_present():
+    assert __version__ == "0.0.1"

chatqpet-0.0.1/tests/test_workflow_contract.py

@@ -0,0 +1,61 @@
+from pathlib import Path
+
+from chatstyle import render_click_tree
+
+from chatqpet.cli import main
+
+
+ROOT = Path(__file__).resolve().parents[1]
+
+
+def _text_blocks(path: Path) -> list[str]:
+    text = path.read_text(encoding="utf-8")
+    return [chunk.split("```", 1)[0].rstrip() for chunk in text.split("```text\n")[1:]]
+
+
+def test_runtime_dependency_contract():
+    pyproject = (ROOT / "pyproject.toml").read_text(encoding="utf-8")
+    cli = (ROOT / "src" / "chatqpet" / "cli.py").read_text(encoding="utf-8")
+
+    assert '"click>=8.0,<9.0"' in pyproject
+    assert '"chatstyle>=0.2.0,<0.3.0"' in pyproject
+    assert '"chatenv>=0.2.10,<0.3.0"' in pyproject
+    assert "add_tree_option" in cli
+    assert "_render_cli_tree" not in cli
+
+
+def test_publish_workflow_is_tag_only_oidc_and_main_guarded():
+    workflow = (ROOT / ".github" / "workflows" / "publish.yml").read_text(encoding="utf-8")
+
+    assert "tags:" in workflow
+    assert "workflow_dispatch" not in workflow
+    assert "id-token: write" in workflow
+    assert "environment:" not in workflow
+    assert "pypa/gh-action-pypi-publish@release/v1" in workflow
+    assert "git fetch --no-tags origin main:refs/remotes/origin/main" in workflow
+    assert 'git merge-base --is-ancestor "${GITHUB_SHA}" refs/remotes/origin/main' in workflow
+
+
+def test_ci_checks_installed_full_and_brief_trees_and_distributions():
+    workflow = (ROOT / ".github" / "workflows" / "ci.yml").read_text(encoding="utf-8")
+
+    assert 'python-version: ["3.10", "3.11", "3.12"]' in workflow
+    assert "chatqpet --version" in workflow
+    assert "chatqpet --tree" in workflow
+    assert "chatqpet --tree-brief" in workflow
+    assert "python -m build" in workflow
+    assert "python -m twine check dist/*" in workflow
+    assert '"$RUNNER_TEMP/chatqpet-wheel/bin/python" -m pip install dist/*.whl' in workflow
+    assert "mkdocs build --strict" in workflow
+
+
+def test_bilingual_cli_tree_docs_match_registered_trees():
+    expected = [
+        render_click_tree(main, root_name="chatqpet"),
+        render_click_tree(main, root_name="chatqpet", brief=True),
+    ]
+
+    for path in (ROOT / "docs" / "cli-tree.md", ROOT / "docs" / "cli-tree.en.md"):
+        text = path.read_text(encoding="utf-8")
+        assert "chatstyle.add_tree_option()" in text
+        assert _text_blocks(path)[:2] == expected