docs(readme): migrate install instructions to PyPI#41
Merged
Conversation
nasde-toolkit is on PyPI as of v0.3.2. The README still pinned a git tag (`uv tool install git+https://...@v0.3.0`), which forced a manual bump in user-facing docs at every release. Quick start now reads `uv tool install nasde-toolkit` — version-agnostic, always lands on the latest stable release. Installation reference adds pipx and pip alternatives, documents the upgrade commands per installer, and mentions the in-CLI update notifier and its NASDE_NO_UPDATE_CHECK opt-out. Also updated the dev-build version example (`0.3.2.dev3` instead of `0.3.1.dev3+gabcdef`) — hatch-vcs no longer emits the local-version suffix after #37. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2 tasks
Small clarification — without context, `uv tool install nasde-toolkit` doesn't make it obvious that the user is getting the most recent stable release (vs. some pinned version, or a dev build). One sentence with a PyPI link removes that ambiguity. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Now that nasde-toolkit is on PyPI as of v0.3.2 (#40, published via #38's automated workflow), the README's git-tag-pinned install command is obsolete and needs replacing with the version-agnostic PyPI command.
What changes
uv tool install git+https://...@v0.3.0→uv tool install nasde-toolkit. Lands on the latest stable release; no more manual bump-the-pin at every tag.NASDE_NO_UPDATE_CHECK=1orCI=true).0.3.1.dev3+gabcdef→0.3.2.dev3. After fix(build): drop local-version segment from hatch-vcs output #37'slocal_scheme = "no-local-version", the+gHASHsuffix is no longer emitted.What's deliberately not changing
docs/adr/*) and historical plans (docs/superpowers/plans/*) keep their original install snippets — they're historical context, not user-facing instructions.Test plan
grep -rn "@v0\." README.md docs/— only matches are GitHub Actions versions (@v4,@v5) in superpowers plans, which are unrelated.