Skip to content

fix(README): update pip install command to include [all] - #1250

Open
stefan-kickoff wants to merge 2 commits into
mainfrom
readme-patch/sgavrilovic
Open

fix(README): update pip install command to include [all]#1250
stefan-kickoff wants to merge 2 commits into
mainfrom
readme-patch/sgavrilovic

Conversation

@stefan-kickoff

@stefan-kickoff stefan-kickoff commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Updated the quick-install command to include all optional features when installing the package.

@stefan-kickoff
stefan-kickoff requested review from a team as code owners August 12, 2026 13:55
@github-actions github-actions Bot added the fix label Aug 12, 2026
@stefan-kickoff stefan-kickoff changed the title fix(README: update pip install command to include [all] fix(README): update pip install command to include [all] Aug 12, 2026
@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Changes

Installation documentation

Layer / File(s) Summary
Update quick-install command
README.md
The PyPI installation command now installs nemo-platform[all].

Suggested reviewers: a2bondar

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the README change to include the [all] extra in the pip install command.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-patch/sgavrilovic

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 454034a and bfe8a9a.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
uv venv --python 3.13
source .venv/bin/activate
uv pip install nemo-platform
uv pip install nemo-platform[all]

@coderabbitai coderabbitai Bot Aug 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 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'
fi

Repository: 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.md

Repository: 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth quoting

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mckornfield Agreed. Use:

uv pip install 'nemo-platform[all]'

You are interacting with an AI system.

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 32014/40717 78.6% 63.4%
Integration Tests 18566/38643 48.0% 20.8%

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Fixes Applied Successfully

Fixed 1 file(s) based on 1 unresolved review comment.

Files modified:

  • README.md

Commit: d97b49a42d8b4ec464d52162c3380d02ca6897d6

The changes have been pushed to the readme-patch/sgavrilovic branch.

Time taken: 1m 8s

Fixed 1 file(s) based on 1 unresolved review comment.

Co-authored-by: CodeRabbit <noreply@coderabbit.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants