Skip to main content

ChatRead

ChatRead 是 ChatArch 的阅读任务工具包。当前 0.0.1 为注册占位版本,仅提供标准命令行骨架,尚未实现阅读业务功能。

文档入口:https://arch.gh.wzhecnu.cn/ChatRead/

按场景选择文档:

场景 文档
第一次安装、运行命令行、确认包可用 CLI 树
校对当前包有哪些一等能力和边界 能力地图
从 Python 代码调用包能力 接口树

快速开始

pip install -e ".[dev]"
chatread --help
chatread --version
chatread --tree
chatread --tree-brief
python -m pytest -q
python -m build

命令行规范

这个模板默认依赖 chatstyle>=0.2.0,<0.3.0 和 chatenv>=0.2.11,<0.3.0,新增命令应优先使用:

  • add_tree_option() 提供共享的 --tree / --tree-brief,render_click_tree() 从已注册 Click 元数据生成命令树。
  • CommandSchema / CommandField 描述输入。
  • add_interactive_option() 提供统一 -i/-I。
  • resolve_command_inputs() 统一缺参补问、默认值、TTY 与校验。
  • 当前没有业务配置项,也不注册空的 ChatEnv provider。后续需要配置时复用 ChatEnv typed profiles,不预设 API Key。

目录结构

  • 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。

Metadata

Release files for ChatRead 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ChatRead 0.0.1
File Size Uploaded
chatread-0.0.1.tar.gz 4.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ChatRead 0.0.1
File Interpreter ABI Platform
chatread-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 9.1 kB

Release files / chatread-0.0.1.tar.gz

Download URL chatread-0.0.1.tar.gz
Size 4.7 kB
Tags Source
SHA-256 checksum
How to use checksums
208472150dd8e5e642f8e295e1447ed76aa2fd5d4943cafbe35b91224f876964
BLAKE2b-256 checksum
How to use checksums
0bbf0a33ab05e3f19e0e05d38a0d7c6451b75ccd48bb859ed368b889353b9c8b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / chatread-0.0.1-py3-none-any.whl

Download URL chatread-0.0.1-py3-none-any.whl
Size 4.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2e1353a789f0edada5b9035029b1bf5a9048024db691b871dc4709141539c36b
BLAKE2b-256 checksum
How to use checksums
2915b7caf5f11ff29485ea0b0b0592935033d6d8c250dd34bd2f44e6dda36ed5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

0.0.2

2 release files

This release

0.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page