docs: fix install instructions -- not published to PyPI - #28
Merged
Conversation
The v1.0.0 release notes claimed `pipx install python-network-toolkit`, implying PyPI availability that doesn't exist -- a mistake caught when the user actually tried it and got "No matching distribution found". The README also never had an end-user Installation section at all, only the Development section's editable-install instructions. Added a real Installation section documenting the path that actually works: `pipx install` directly from this git repo, optionally pinned to a tag. Already corrected the published v1.0.0 GitHub Release notes to match (gh release edit, no PR needed for that -- it's release metadata, not repo content). Verified: `pipx install "git+https://github.com/.../python-network-toolkit.git"` (both unpinned and pinned to @v1.0.0) installs cleanly and `netk --help`/ `netsniff --version` both work, exactly as documented. Full pytest suite, ruff, and mypy unaffected (a docs-only repo change). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
✅ AgentGate: Passed2 files changed · +17 -0 lines No issues found. Generated by AgentGate |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes a mistake in the
v1.0.0release: the release notes claimedpipx install python-network-toolkit, implying PyPI availability that doesn't exist — caught when you actually tried it and got "No matching distribution found." Apologies for that — I'd only verifiedpipx install .from a local checkout, and wrote the release notes as if that implied PyPI availability, which it doesn't.The README also never had an end-user Installation section at all — only the Development section's editable-install (
pip install -e ".[dev]") instructions, which aren't what a regular user wants.pipx installdirectly from this git repo (optionally pinned to a tag).v1.0.0GitHub Release notes to match (viagh release edit— that's release metadata, not repo content, so no PR needed for that half).Test plan
pipx install "git+https://github.com/brett-buskirk/python-network-toolkit.git"(unpinned, installs frommain) — installs cleanly,netk --helpandnetsniff --versionboth work@v1.0.0— same resultpytestsuite,ruff,mypy— unaffected (a docs-only change)🤖 Generated with Claude Code