Skip to content

docs: update python installation range - #781

Merged
mckornfield merged 8 commits into
mainfrom
rrhyne/install-readme
Jul 27, 2026
Merged

docs: update python installation range#781
mckornfield merged 8 commits into
mainfrom
rrhyne/install-readme

Conversation

@rrhyne

@rrhyne rrhyne commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

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

  • Documentation
    • Updated documented local setup Python compatibility across getting started, requirements, support matrix, and release notes to 3.11–3.13 (dropping 3.14).
    • Tightened prerequisites to require uv>=0.9.14,<0.10.0 and Node.js 22.18.x with pnpm for the web UI.
    • Streamlined local install guidance to a uv workflow (uv venv, uv pip install nemo-platform, nemo setup) and clarified source-checkout steps.
    • Removed legacy Python 3.14 workaround guidance, including PYO3_USE_ABI3_FORWARD_COMPATIBILITY.

@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 27292/35040 77.9% 62.1%
Integration Tests 16024/33752 47.5% 19.9%

@rrhyne rrhyne changed the title Update README.md install instructions docs: update README.md install instructions Jul 20, 2026
@github-actions github-actions Bot added the docs label Jul 20, 2026
@rrhyne
rrhyne force-pushed the rrhyne/install-readme branch from b947d7f to ba55280 Compare July 20, 2026 16:42
@rrhyne
rrhyne marked this pull request as ready for review July 21, 2026 13:47
@rrhyne
rrhyne requested review from a team as code owners July 21, 2026 13:47
@rrhyne
rrhyne requested a review from mckornfield July 21, 2026 13:47
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Full local setup documentation now supports Python 3.11–3.13, requires constrained uv, and uses uv installation commands. Python 3.14 workaround instructions were removed and compatibility notes were aligned across release, support, and package documentation.

Changes

Installation documentation

Layer / File(s) Summary
Primary installation flow
README.md, docs/get-started/setup.mdx
Prerequisites and PyPI setup now use constrained uv, Python 3.13 environment creation, uv pip install nemo-platform, and nemo setup.
Compatibility and support guidance
docs/requirements.mdx, docs/support-matrix.mdx, docs/cli/index.mdx, docs/about/release-notes/*.mdx
Compatibility guidance now documents Python 3.11–3.13, constrains the recommended uv version, and removes Python 3.14 ABI workaround text.
Package installation documentation
packages/nemo_platform/README.md, packages/nemo_platform_plugin/src/nemo_platform_plugin/README.md, packages/nemo_platform_plugin/src/nemo_platform_plugin/docs/QUICKSTART.md
Package and plugin installation instructions specify Python 3.11–3.13 and remove Python 3.14 workaround commands.

Possibly related PRs

Suggested reviewers: ironcommit, svvarom

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the main docs change: updating Python installation guidance and supported range.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rrhyne/install-readme

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

📥 Commits

Reviewing files that changed from the base of the PR and between 848ea33 and f6086a8.

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

Comment thread README.md Outdated
Comment thread README.md Outdated

@mckornfield mckornfield 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.

I assume 3.13 works as well or did you run into issues with it as well?

Comment thread README.md Outdated

@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: 3

🧹 Nitpick comments (1)
packages/nemo_platform_plugin/src/nemo_platform_plugin/docs/QUICKSTART.md (1)

7-7: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win

Pin uv consistently with the setup guide.

Use the supported constraint >=0.9.14,<0.10.0 here, 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

📥 Commits

Reviewing files that changed from the base of the PR and between da74d51 and a688764.

📒 Files selected for processing (11)
  • README.md
  • docs/about/release-notes/current-release.mdx
  • docs/about/release-notes/release-0-1-0.mdx
  • docs/about/release-notes/release-0-2-0.mdx
  • docs/cli/index.mdx
  • docs/get-started/setup.mdx
  • docs/requirements.mdx
  • docs/support-matrix.mdx
  • packages/nemo_platform/README.md
  • packages/nemo_platform_plugin/src/nemo_platform_plugin/README.md
  • packages/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

Comment thread docs/get-started/setup.mdx
Comment thread docs/get-started/setup.mdx
Comment thread packages/nemo_platform_plugin/src/nemo_platform_plugin/README.md
rrhyne and others added 5 commits July 24, 2026 21:09
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>
@mckornfield
mckornfield force-pushed the rrhyne/install-readme branch from e696c5b to 9aacaae Compare July 24, 2026 21:10
@mckornfield
mckornfield enabled auto-merge July 24, 2026 21:10
@mckornfield
mckornfield added this pull request to the merge queue Jul 24, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 24, 2026
@mckornfield
mckornfield enabled auto-merge July 24, 2026 23:00
@mckornfield
mckornfield added this pull request to the merge queue Jul 24, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 24, 2026
@mckornfield
mckornfield added this pull request to the merge queue Jul 27, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 27, 2026
@mckornfield mckornfield changed the title docs: update README.md install instructions docs: update python installation range Jul 27, 2026
@mckornfield
mckornfield enabled auto-merge July 27, 2026 22:50
@mckornfield
mckornfield added this pull request to the merge queue Jul 27, 2026
Merged via the queue into main with commit 7afc478 Jul 27, 2026
61 of 62 checks passed
@mckornfield
mckornfield deleted the rrhyne/install-readme branch July 27, 2026 23:13
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.

2 participants