整理 README 和样例日志,发布 hwlog 0.1.0
本节目录
hwlog 0.1.0 已发布。 下载包包含源码、wheel 安装包、12 项回归测试、README 和合成日志。解压后可以直接跟着这一章复现两次排查。 下载 hwlog 0.1.0 发布包 · 回顾慢接口排查
hwlog 0.1.0 的发布包含源码、wheel、README 和合成样例。 GitHub 源码 · v0.1.0 Release · 下载完整 ZIP

README 写给第一次拿到包的人
这版 README 先给出 Python 要求和安装命令,再给一条可复制的快速验证命令。之后说明两个案例文件、每个指标的口径和怎样重建 wheel。读者拿到源码时,可以用同一份样例判断「我装对了吗」。
hwlog-0.1.0/
README.md
pyproject.toml
src/hwlog/
tests/
dist/helloworld_log_cli-0.1.0-py3-none-any.whl
examples/
access.jsonl
5xx.jsonl
latency.jsonl
compare_5xx.py
slow_paths.py
make_examples.py
expected/
先核对下载,再安装
可以在 ZIP 所在目录运行下面这段 Python,检查发布包的 SHA-256。把它保存为 verify_zip.py 并运行。
from hashlib import sha256
from pathlib import Path
archive = Path("hwlog-0.1.0.zip")
expected = "838ef6d418c9c20394f63eda4567e7b923830370dd64fce5d79e6030d5566628"
actual = sha256(archive.read_bytes()).hexdigest()
if actual != expected:
raise SystemExit("SHA-256 不匹配,请重新下载。")
print("SHA-256 校验通过")
解压后,在干净的 Python 3.11 或更高版本虚拟环境中进入 hwlog-0.1.0 目录。第一条命令安装包里自带的 wheel,第二条用第三章的合成样例核对输出。
python -m pip install --no-deps dist/helloworld_log_cli-0.1.0-py3-none-any.whl
hwlog examples/access.jsonl --since 2026-11-19T16:00:00Z --until 2026-11-19T17:00:00Z --top 1 --format csv
method,path,requests
GET,/search,3
安装运行版时无需安装 pytest。要修改源码并跑测试,可以执行 python -m pip install -e ".[test]" 和 python -m pytest -q。如需从源码生成安装包,再运行 python -m pip wheel --no-deps --wheel-dir dist .。发布验证时,我在一个全新的环境里安装了实际下载包里的 wheel,并复跑了示例。 Python Packaging User Guide
给下一次改动留一个可复现的起点
练习时先从 ZIP 解压一份新的目录,用 README 里的两条命令复现 5xx 排查和慢接口报表,再与 examples/expected/ 对照。然后把终端切到解压目录之外,给 hwlog 传入样例日志的绝对路径。这能确认工具来自已安装的包,样例来自命令指定的位置。
五章学完,你已经从逐行读文件走到了会测试、可安装、能导出报表的工具。以后加字段或改指标,可以先写一条能复现问题的样例,再用测试确认现有报表是否受到影响。