docs: add PyPI as second supported install route (#3425)#3516
Merged
Conversation
The specify-cli package is now officially published to PyPI via the publish-pypi.yml trusted-publishing workflow. Document PyPI as a supported install route alongside the GitHub source install: - Revise the outdated "not affiliated" warning in installation.md to reflect that specify-cli on PyPI is an official, maintained channel. - Add an "Install from PyPI" section and list PyPI under alternative package managers. - Add a dedicated docs/install/pypi.md guide (install, pin version, verify, upgrade, uninstall). - Add the PyPI guide to the docs TOC. - Mention the PyPI route in the README quick start. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Documents PyPI as Spec Kit’s second supported installation channel.
Changes:
- Adds PyPI installation, upgrade, and removal guidance.
- Updates installation documentation and verification wording.
- Adds PyPI navigation and README onboarding.
Show a summary per file
| File | Description |
|---|---|
README.md |
Adds the PyPI quick-install route. |
docs/toc.yml |
Adds the PyPI guide to navigation. |
docs/installation.md |
Documents both official distribution channels. |
docs/install/pypi.md |
Adds the dedicated PyPI guide. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 4
- Review effort level: Medium
Address review feedback for the PyPI install documentation: - Reword the verification guidance so `specify version` is described as a local version/runtime check rather than proof of package provenance. - Clarify that upgrading a pinned `uv tool` install to the newest PyPI release requires an unpinned reinstall command. - Note that `specify self upgrade` rebuilds `uv tool` and `pipx` installs from the GitHub source release URL rather than preserving a PyPI-based installation. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Assisted-by: GitHub Copilot (model: MAI-Code-1-Flash, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Address review feedback: version/list commands do not reveal install provenance. Direct readers to the source metadata their package manager records (pipx list --json, PEP 610 direct_url.json) to confirm whether an install came from PyPI or a Git URL, and note pip show cannot see uv/pipx-managed environments. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Collaborator
Author
|
Addressed the verification-provenance feedback in Posted on behalf of @mnriem by GitHub Copilot (model: Claude Opus 4.8). |
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
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
Closes #3425.
The
specify-clipackage is now officially published to PyPI (live at pypi.org/project/specify-cli, with versions matching Spec Kit releases) via thepublish-pypi.ymltrusted-publishing workflow. This documents PyPI as a supported install route alongside the existing GitHub source install.Changes
docs/installation.md: Replaced the outdated "PyPI packages are not affiliated" warning with an accurate note stating both the GitHub repository and thespecify-cliPyPI package are official, maintained channels. Added an Install from PyPI section, listed the two supported routes up front, and updated the verification note.docs/install/pypi.md(new): Dedicated PyPI guide covering install (uv / pipx / pip), pinning a version, verify, upgrade, and uninstall. Notes that a plainpip installis not managed byspecify self upgrade.docs/toc.yml: Added the new PyPI guide to the navigation.README.md: Mentioned the PyPI install route in the Get Started section.Notes
The GitHub source install remains the recommended (pinned) route; PyPI is documented as the second supported route as requested in the issue.
This PR was authored autonomously by GitHub Copilot (model: Claude Opus 4.8) on behalf of @mnriem.