docs(installation): document the 'py' (Python) script type#3640
Merged
Conversation
The installation guide's "Specify Script Type" section only showed `--script sh` and `--script ps`, and the installed-variant list only mentioned `.specify/scripts/bash/` and `.specify/scripts/powershell/`. The CLI has a third script type, `py`: `SCRIPT_TYPE_CHOICES` in `_agent_config.py` includes `"py": "Python"`, and `shared_infra.py` installs a `python/` variant directory (plus the platform shell fallback) when `--script py` is chosen. Add the missing `--script py` force example and a `.specify/scripts/python/` bullet so the docs match the code. Docs-only. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Documents Python as a supported Specify script type.
Changes:
- Adds a
--script pyexample. - Documents the Python scripts directory and shell fallback.
Show a summary per file
| File | Description |
|---|---|
docs/installation.md |
Adds Python script installation guidance. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Medium
Address review feedback: update the section heading and intro so Python is presented as a first-class script type alongside Shell and PowerShell, matching the added --script py example and python/ variant directory. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Addressed the review feedback in 7e6ca7c: the section heading is now "Specify Script Type (Shell, PowerShell, or Python)" and the intro presents all three ( |
Collaborator
|
Thank you! |
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.
What
The installation guide's Specify Script Type section documented only two script types (
sh,ps) in its force-example block, and the installed-variant list mentioned only.specify/scripts/bash/and.specify/scripts/powershell/. The CLI actually supports a third:src/specify_cli/_agent_config.py→SCRIPT_TYPE_CHOICES = {"sh": ..., "ps": ..., "py": "Python"}src/specify_cli/commands/init.py→--scripthelp: "Script type to use: sh, ps, or py"src/specify_cli/shared_infra.py(~L407) →script_type == "py"installsvariant_dirs = ("python", <platform shell>), i.e. apython/directory plus the platform shell fallback.Fix
Two additions to
docs/installation.md:specify init <project_name> --script pyforce example, and.specify/scripts/python/bullet in the installed-variant list.Docs-only.
markdownlint-cli2reports no new issues on the added lines (the two pre-existingMD049findings at line 9 are unrelated and untouched).AI-assisted: authored with Claude Code. I verified
pyagainstSCRIPT_TYPE_CHOICES, the--scriptoption help, and theshared_infra.pyvariant-dir mapping.