docs: refresh PyPI install guidance#8
Conversation
- make PyPI the default public install path - document active Trusted Publishing release flow - update distribution policy tests Tests: ruff check src/ tests/; python3 -m pytest tests/test_distribution_policy.py tests/test_versioning.py -q -p no:cacheprovider; python3 -m pytest -q -p no:cacheprovider
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 44052562d0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ```bash | ||
| uv tool install 'git+https://github.com/saagpatel/GithubRepoAuditor.git#egg=github-repo-auditor[serve]' | ||
| pip install "github-repo-auditor[serve]" |
There was a problem hiding this comment.
When a user follows the recommended uv tool install or pipx install path above and later wants the web UI, this pip install command installs the [serve] extra into whatever Python environment pip targets, not into the already-created isolated tool environment. The audit executable from uv/pipx will still hit _run_serve_mode's missing-extra path unless the extra is installed into that tool environment, so the README should give a tool-aware reinstall/inject command for github-repo-auditor[serve] rather than plain pip install.
Useful? React with 👍 / 👎.
1 participant
What
Why
github-repo-auditoris now published on PyPI, so the public README and PyPI long description need to tell the truth.How
Testing
Performance Impact
Risk / Notes
v0.1.3is needed so PyPI displays the corrected README.