fix(README): update pip install command to include [all] - #1250
fix(README): update pip install command to include [all]#1250stefan-kickoff wants to merge 2 commits into
Conversation
📝 WalkthroughWalkthroughChangesInstallation documentation
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 25: Update the installation command in the README to quote the
nemo-platform[all] package specifier, preserving the all extra while preventing
shell glob expansion.
🪄 Autofix
✅ Autofix completed
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: b2db9659-2388-4cf4-a587-e32db84d2467
📒 Files selected for processing (1)
README.md
| uv venv --python 3.13 | ||
| source .venv/bin/activate | ||
| uv pip install nemo-platform | ||
| uv pip install nemo-platform[all] |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
set -eu
printf '%s\n' '--- README context ---'
cat -n README.md | sed -n '18,32p'
printf '%s\n' '--- package metadata mentioning extras ---'
rg -n -i '(^|[[:space:]])all([[:space:]]|["'\'']|=)|optional-dependencies|extras' \
-g 'pyproject.toml' -g 'setup.cfg' -g 'setup.py' -g 'poetry.lock' -g '*.ini' -g '*.toml' .
printf '%s\n' '--- shell behavior ---'
tmpdir="$(mktemp -d)"
trap 'rm -rf "$tmpdir"' EXIT
cd "$tmpdir"
touch nemo-platforma nemo-platforml
printf 'bash: '
bash -c 'set -f; printf "%s\n" nemo-platform[all]' 2>&1 || true
printf 'bash with globbing: '
bash -c 'printf "%s\n" nemo-platform[all]' 2>&1 || true
if command -v zsh >/dev/null 2>&1; then
printf 'zsh with globbing: '
zsh -c 'printf "%s\n" nemo-platform[all]' 2>&1 || true
else
printf '%s\n' 'zsh: unavailable'
fiRepository: NVIDIA-NeMo/nemo-platform
Length of output: 8175
🏁 Script executed:
set -eu
printf '%s\n' '--- published package metadata source ---'
cat -n packages/nemo_platform/pyproject.toml | sed -n '1,58p'
printf '%s\n' '--- README install command occurrences ---'
rg -n -C 2 'uv pip install .*nemo-platform' README.mdRepository: NVIDIA-NeMo/nemo-platform
Length of output: 2790
Quote the package extra.
Use uv pip install 'nemo-platform[all]' to prevent shell glob expansion from changing the package specifier or causing a shell error.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 25, Update the installation command in the README to quote
the nemo-platform[all] package specifier, preserving the all extra while
preventing shell glob expansion.
Source: Coding guidelines
There was a problem hiding this comment.
Might be worth quoting
There was a problem hiding this comment.
@mckornfield Agreed. Use:
uv pip install 'nemo-platform[all]'You are interacting with an AI system.
|
Fixes Applied SuccessfullyFixed 1 file(s) based on 1 unresolved review comment. Files modified:
Commit: The changes have been pushed to the Time taken: |
Fixed 1 file(s) based on 1 unresolved review comment. Co-authored-by: CodeRabbit <noreply@coderabbit.ai>
Summary by CodeRabbit