安装与启动:让 PyCourt 跑起来¶
目标:让初次接触 PyCourt 的你,在几分钟内完成:安装 → 启动。
第一步:安装¶
方式一:多项目开发¶
pipx install pycourt
- pipx 会给 pycourt 创建一个单独的虚拟环境;
- 你机器上的所有项目都可以直接在命令行里用 pycourt(就像 black、ruff、poetry 一样);
- 不需要在每个项目里重复安装,只要一个 pipx install 就够了。
方式二:单项目开发¶
对于非 poetry 管理的单项目,请在该项目的虚拟环境中执行,避免在系统环境里直接安装:
pip install pycourt
- pycourt 被视为“这个项目的依赖”;
- 另一个项目如果也想用,就要在它自己的虚拟环境里再装一次;
- 好处是:每个项目可以固定自己的版本,比如:
- 项目 A 用 pycourt==0.2.x
- 项目 B 用 pycourt==0.3.x
方式三:poetry 项目¶
使用 poetry 管理的项目:
poetry add -D pycourt
pycourt 将作为开发依赖写入 pyproject.toml 并自动更新锁文件;
在这个项目里可以通过 poetry run 来运行 PyCourt 。
验证安装¶
安装完成后,可以先确认一下版本与帮助信息:
pycourt --help
# 或者
poetry run pycourt --help
看到包括 file / scope / project / init 在内的子命令列表,表示安装成功。
第二步:启动¶
在项目根做一次“整体预览”,例如:
pycourt scope . --non-blocking
PyCourt 会:
- 以当前目录为根,递归扫描
.py文件; - 按法条输出发现的“违宪行为”以及解决方案。
- 想看机器可读结果,可以加 --format json;
- 想在终端里不让审计被违宪终止,可以加 --non-blocking。
下一步:配置¶
- 如果项目里已经有不少“违宪行为”,会直接看到具体的违宪列表和解决方案;
- 不要慌,这是让你的代码变健康和优雅的开始。
你已经掌握了 pycourt 的基本用法,接下来,你需要进一步掌握更多使用方法和技巧,来掌控你的代码质量。
请继续: