docs: update python installation range - #781
Conversation
|
b947d7f to
ba55280
Compare
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughFull local setup documentation now supports Python 3.11–3.13, requires constrained ChangesInstallation documentation
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 16: Update the README prerequisites statement to align with the Python
version range declared by the package metadata, including Python 3.13, or
explicitly label the narrower 3.11–3.12 range as the tested quick-install range.
Keep the documented support claim consistent with the pyproject.toml contract.
- Around line 21-23: Update the README prerequisites around the uv venv and
installation commands to explicitly require uv>=0.9.14,<0.10.0. Document the
supported uv installation command or version constraint before these setup
steps, rather than relying on whichever uv version is on PATH.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 3aaca25c-fa8c-4946-b5c6-41da2d4dcf3c
📒 Files selected for processing (1)
README.md
mckornfield
left a comment
There was a problem hiding this comment.
I assume 3.13 works as well or did you run into issues with it as well?
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
packages/nemo_platform_plugin/src/nemo_platform_plugin/docs/QUICKSTART.md (1)
7-7: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winPin uv consistently with the setup guide.
Use the supported constraint
>=0.9.14,<0.10.0here, or explicitly state that this quickstart does not depend on the constrained uv workflow.🤖 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 `@packages/nemo_platform_plugin/src/nemo_platform_plugin/docs/QUICKSTART.md` at line 7, Update the QUICKSTART prerequisites to specify uv>=0.9.14,<0.10.0 consistently with the setup guide, or explicitly state that this quickstart does not use the constrained uv workflow.
🤖 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 `@docs/get-started/setup.mdx`:
- Around line 15-16: Update the PyPI installation flow in the setup
documentation to use the pinned uv workflow instead of pip, including replacing
the pip prerequisite and any python -m venv/pip install commands with the
repository’s constrained uv commands. Keep the source-checkout prerequisites and
installation flow unchanged.
- Around line 12-16: Align the Python requirement metadata in
packages/nmp_common/pyproject.toml with the documented Python 3.11–3.13 contract
by removing Python 3.14 from supported/classified versions. Keep the existing
3.11–3.13 wording unchanged in docs/get-started/setup.mdx ranges 12-16 and
31-32, and packages/nemo_platform/README.md ranges 4, 22, and 33-36; these sites
require no direct changes.
In `@packages/nemo_platform_plugin/src/nemo_platform_plugin/README.md`:
- Line 28: Align the Python-version badge with the prerequisite text in the
README by changing the badge from Python 3.11–3.14 to Python 3.11–3.13. Keep the
existing prerequisite wording unchanged.
---
Nitpick comments:
In `@packages/nemo_platform_plugin/src/nemo_platform_plugin/docs/QUICKSTART.md`:
- Line 7: Update the QUICKSTART prerequisites to specify uv>=0.9.14,<0.10.0
consistently with the setup guide, or explicitly state that this quickstart does
not use the constrained uv workflow.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: d53a6cb4-0298-4abe-998a-f9e9d49ebd19
📒 Files selected for processing (11)
README.mddocs/about/release-notes/current-release.mdxdocs/about/release-notes/release-0-1-0.mdxdocs/about/release-notes/release-0-2-0.mdxdocs/cli/index.mdxdocs/get-started/setup.mdxdocs/requirements.mdxdocs/support-matrix.mdxpackages/nemo_platform/README.mdpackages/nemo_platform_plugin/src/nemo_platform_plugin/README.mdpackages/nemo_platform_plugin/src/nemo_platform_plugin/docs/QUICKSTART.md
🚧 Files skipped from review as they are similar to previous changes (7)
- docs/about/release-notes/release-0-2-0.mdx
- docs/requirements.mdx
- docs/about/release-notes/release-0-1-0.mdx
- docs/about/release-notes/current-release.mdx
- README.md
- docs/support-matrix.mdx
- docs/cli/index.mdx
Changes quick install instructions to use UV pinned to a compatible version of instead of python and an venv as we do not support python 3.14 commonly found on updated macs today. NOTE: Does not address later references to 3.14 Signed-off-by: Rob Rhyne <rrhyne@nvidia.com>
Only required when we support 3.14 Signed-off-by: Rob Rhyne <rrhyne@nvidia.com>
Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
e696c5b to
9aacaae
Compare
Changes quick install instructions to use UV pinned to a compatible version of instead of python and an venv as we do not support python 3.14 commonly found on updated macs today.
NOTE: Does not address later references to 3.14
Summary by CodeRabbit