Skip to content

fix(sdk): add [project.urls] to nemo-platform wrapper distribution - #1512

Merged
mckornfield merged 1 commit into
mainfrom
docs-pypi-project-urls/glody
Aug 26, 2026
Merged

fix(sdk): add [project.urls] to nemo-platform wrapper distribution#1512
mckornfield merged 1 commit into
mainfrom
docs-pypi-project-urls/glody

Conversation

@glody

@glody glody commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Published PyPI wheel currently has info.project_urls == null and no home_page, so the pypi.org/project/nemo-platform/ sidebar shows no Project links section. Users landing on PyPI cannot navigate to the docs site or the GitHub repo.

Sister distribution nemo-platform-plugin already sets these; this mirrors that pattern on the main wrapper. Documentation points at the public docs site. Bug Tracker is omitted per review on the original fork PR.

This recreates fork PR #1475 as a same-repo branch so GitHub Actions can use org Docker Hub secrets.

Changes

  • Add [project.urls] (Homepage, Documentation, Source) to packages/nemo_platform/pyproject.toml

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification: packaging metadata only; no runtime behavior change
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification: PyPI sidebar metadata, not product docs

Verification

  • Pull request title follows the repository's Conventional Commit format
  • Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • No secrets, API keys, or credentials are included

Targeted validation:

  • Recreated on origin/main (b2ba47187) so CI runs in the canonical repo.
  • DCO audit: Signed-off-by: Jinxiang Guo <jinxiang@nvidia.com> matches commit author.
  • Diff limited to the four [project.urls] lines (no unrelated pyproject.toml churn).
  • Full uv run pre-commit run -a was not rerun for this metadata-only replay; GitHub CI on the same-repo branch is the gate.

Summary by CodeRabbit

  • Documentation
    • Added project homepage, documentation, and source repository links to the package metadata.

@github-actions

github-actions Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 35422/45214 78.3% 62.8%
Integration Tests 21110/42989 49.1% 22.3%

@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 3b74ac64-2d75-4896-9066-e5736f5e6ed3

📥 Commits

Reviewing files that changed from the base of the PR and between 27c6b27 and f3c3ea5.

📒 Files selected for processing (1)
  • packages/nemo_platform/pyproject.toml
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/nemo_platform/pyproject.toml

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Walkthrough

Walkthrough

The package metadata now defines URLs for the project homepage, documentation, and source repository.

Changes

Project metadata

Layer / File(s) Summary
Project URL metadata
packages/nemo_platform/pyproject.toml
Adds homepage, documentation, and source repository URLs to the project metadata.

Merge Risk: ⚪ Minimal · up to f3c3e

This change adds PyPI project links without affecting runtime behavior, and no actionable merge-blocking risk remains beyond normal checks and review.

🚥 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 addition of [project.urls] metadata to the nemo-platform wrapper distribution.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-pypi-project-urls/glody

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

Published PyPI wheel currently has `info.project_urls == null` and no
`home_page`, so the pypi.org/project/nemo-platform/ sidebar shows no
Homepage / Documentation / Source links. Users cannot navigate from
PyPI to the docs site or the GitHub repo.

Sister distribution nemo-platform-plugin already sets these; mirror the
same pattern for the main wrapper. Documentation points to the public
docs site (docs.nvidia.com/nemo-platform) rather than an in-repo folder,
matching where users actually land from the CLI/PyPI. Bug Tracker was
omitted per review on the original fork PR.

Signed-off-by: Jinxiang Guo <jinxiang@nvidia.com>
Signed-off-by: Glody Guo <jinxiang@nvidia.com>
@glody
glody force-pushed the docs-pypi-project-urls/glody branch from 27c6b27 to f3c3ea5 Compare August 26, 2026 02:27
@mckornfield
mckornfield added this pull request to the merge queue Aug 26, 2026
Merged via the queue into main with commit be9df41 Aug 26, 2026
60 checks passed
@mckornfield
mckornfield deleted the docs-pypi-project-urls/glody branch August 26, 2026 03:48
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