Skip to content

Add jobset_api Python package for PyPI publishing#1149

Draft
rahulmansharamani14 wants to merge 5 commits intokubernetes-sigs:mainfrom
rahulmansharamani14:feat/pypi-python-api-package
Draft

Add jobset_api Python package for PyPI publishing#1149
rahulmansharamani14 wants to merge 5 commits intokubernetes-sigs:mainfrom
rahulmansharamani14:feat/pypi-python-api-package

Conversation

@rahulmansharamani14
Copy link

What type of PR is this?

/kind feature

What this PR does / why we need it:

tl;dr: The JobSet Python SDK is not available on PyPI. This PR creates a new jobset_api package that can be published to PyPI, allowing users to pip install jobset_api to get JobSet API models.

This PR replaces the old auto-generated Python SDK (sdk/python/) with a new lightweight jobset_api Python package at api/python_api/, modeled after Kubeflow Trainer's kubeflow_trainer_api. The package generates only Pydantic models (no
API client, tests, or docs) and is designed to be published to PyPI.

Changes:

  • Add VERSION file at repo root for version stamping
  • Add api/python_api/ package with pyproject.toml, __init__.py, and README.md
  • Add hack/python-api/gen-api.sh generation script (OpenAPI Generator v7.13.0, models-only)
  • Add hack/python-api/swagger_config.json with jobset_api package name
  • Update Makefile to use new generator, remove test-python-sdk target, update verify and prepare-release-branch
  • Update .gitignore and AGENTS.md references
  • Remove old sdk/python/ and hack/python-sdk/ directories
  • Add GitHub Actions workflow for PyPI publishing via OIDC trusted publishing

Post-merge maintainer action required:

  1. Register jobset_api on PyPI
  2. Configure OIDC trusted publishing: repo=kubernetes-sigs/jobset, workflow=publish-python-api.yaml, environment=pypi

Which issue(s) this PR fixes:

Fixes #736

Special notes for your reviewer:

This follows the same pattern as Kubeflow Trainer's Python API package (ref).

Does this PR introduce a user-facing change?

Add jobset_api Python package for publishing JobSet API models to PyPI.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 8, 2026
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: rahulmansharamani14
Once this PR has been reviewed and has the lgtm label, please assign giuseppett for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Feb 8, 2026

CLA Signed
The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

Welcome @rahulmansharamani14!

It looks like this is your first PR to kubernetes-sigs/jobset 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/jobset has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 8, 2026
@k8s-ci-robot
Copy link
Contributor

Hi @rahulmansharamani14. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 8, 2026
@netlify
Copy link

netlify bot commented Feb 8, 2026

Deploy Preview for kubernetes-sigs-jobset canceled.

Name Link
🔨 Latest commit 0b0d9f2
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-sigs-jobset/deploys/6988972f3b91550008e128ef

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Feb 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

pypi release github action for python sdk

2 participants

Comments