Skip to main content

wl_cli(wl CLI)

wl_cli 是一个以 Click 构建的命令行工具(入口 wl),面向 Python 项目的初始化、构建、 测试、格式化、lint、清理与质量门等日常开发工作流。发行物是纯 Python wheel (py3-none-any),安装与运行都不需要 Rust 工具链;Rust 扩展是可选的诊断件, 缺失时自动回落纯 Python 实现。

功能概览

命令 用途
wl init 初始化项目环境(Git、虚拟环境、i18n、Rust 子模块等)
wl build 执行构建任务,支持 Python 包构建与分发
wl test 运行测试(支持缓存、覆盖率、逐步模式)
wl format 格式化 Python 与 Rust 代码
wl lint 代码质量检查(ruff/mypy 等)
wl clean 清理构建产物与临时文件
wl debug (已弃用)质量门 — 改用 wl test -s 与 wl format -s
wl self 自管理命令

命令行别名:b→build、c→clean、f→format、i→init。 完整命令参考见 CLI_COMMANDS.md。

环境要求

  • Python >= 3.11(纯 Python 路径,安装与运行都不需要 Rust/cargo)
  • 包管理器推荐 uv

平台支持矩阵

平台 架构 支持
macOS x86_64 / arm64 ✅
Linux(glibc) x86_64 / aarch64 ✅
Linux(musl) x86_64 / aarch64 ✅
Windows x64 / arm64 ✅

同一个 py3-none-any wheel 覆盖以上全部平台。平台报告由 wl_cli.platform.platform_payload() 统一产出 (platform / python / native_extension / supported / reason), 其中 native_extension 只作诊断——Rust 扩展可选,缺失不影响 supported。

安装

稳定版(PyPI)

pip install py-wlcli

按需安装可选 extra:pip install "py-wlcli[lfs]"(LFS watch)、 pip install "py-wlcli[test]"(测试套件)、pip install "py-wlcli[dev]"(开发工具)。 详见安装文档。

开发版(从源码)

# 以 GitLab 为主仓(origin),GitHub 为镜像
git clone https://gitlab.gewinnrobo.com/Humuyuan/wl-cli.git
cd wl_cli
uv pip install -e ".[dev,test]"

GitHub 镜像:https://github.com/CharlieZi/wl-cli.git

快速开始

wl --help       # 查看帮助
wl init         # 初始化项目
wl build        # 构建
wl test         # 运行测试
wl format       # 格式化代码
wl lint         # 代码质量检查

测试与质量门

wl test              # 运行全部测试
wl test --cover      # 覆盖率(阈值 70%)
wl test -s           # 逐个测试文件运行,首个失败即停
pytest tests/ -v     # 指定文件(pytest 直跑)

提交前请确保 pre-commit 通过(ruff、codespell、lockfile 一致性等)。 开发约束详见 CLAUDE.md, 贡献流程见 CONTRIBUTING.md。

文档

架构速览

Click CLI(src/wl_cli/cli_click.py 经 setup_commands() 直接注册)→ 各命令实现(commands/<group>/)→ 业务逻辑。 Rust 扩展是可选的诊断件:src/wl_cli/lib/rust_utils.py 在 wl_cli_native 不可用时回落纯 Python;发行 wheel 不包含任何原生二进制。 架构演进背景见 Click 迁移设计。

许可证

MIT,见 LICENSE。

Metadata

Release files for py-wlcli 0.8.0

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

Source distribution (sdist)

Source distribution for py-wlcli 0.8.0
File Size Uploaded Provenance Actions
py_wlcli-0.8.0.tar.gz 480.0 kB Without provenance Details for py_wlcli-0.8.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for py-wlcli 0.8.0
File Interpreter ABI Platform Actions
py_wlcli-0.8.0-py3-none-any.whl Python 3 none any Details for py_wlcli-0.8.0-py3-none-any.whl

Total release size: 1.1 MB

Release files / py_wlcli-0.8.0.tar.gz

Download URL py_wlcli-0.8.0.tar.gz
Size 480.0 kB
Tags Source
SHA-256 checksum
How to use checksums
ae4bb3d0f83999a427c83fe17fa0e3afb18a210b1d68168abd5d61d26b0e827f
BLAKE2b-256 checksum
How to use checksums
dae0406c11c96254f2ca85faba609554f7a2e11c90a422772c4408fccf85b99e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.14

Release files / py_wlcli-0.8.0-py3-none-any.whl

Download URL py_wlcli-0.8.0-py3-none-any.whl
Size 626.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
087cd1985ed169eab00a80f5410b66ab04eb9acba1ab50150c57c0d293f85bc8
BLAKE2b-256 checksum
How to use checksums
f92b0578b380aa2c9a4e98b92761b2d1ecb5e0cdc9d2bfade9eb096afca2623b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.14

Security for py-wlcli 0.8.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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