Release Python Sdk

1. Abort the release (recommended if unsure)
2. Stash changes for later: git stash --include-untracked

Step 1: Update the Version and Create Release Branch

Edit the version field in pyproject.toml to the new version number, following Semantic Versioning:

• MAJOR: incompatible API changes
• MINOR: backward-compatible new functionality
• PATCH: backward-compatible bug fixes

Then set the VERSION env var from pyproject.toml and create a release branch:

export VERSION=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
echo "Releasing version: ${VERSION}"
git checkout -b release/${VERSION}

Step 2: Update Dependencies (if needed)

buf generate

Step 3: Run Quality Checks

black --exclude '.*_pb2(_grpc)?\.py' src/ examples/
flake8 --exclude '*_pb2.py,*_pb2_grpc.py' src/ examples/
python -c "import examples.check"
python -c "import examples.auth"
pytest
python -m build

Step 4: Documentation Audit (optional)

Check if the README is up to date with the current codebase:

1. Examples: Compare the files in examples/*.py against the "Examples" section in the README. Flag any examples that exist on disk but are not listed in the README.
2. Available Services: If a local Kessel instance is running, list endpoints with grpcurl -plaintext localhost:9081 list kessel.inventory.v1beta2.KesselInventoryService and compare against the "Available Services" section in the README. Flag any undocumented endpoints.

Present any gaps to the user and ask if they'd like to update the README before releasing. Skip the grpcurl check if no local instance is available.

Step 5: Review Changes

Before committing, summarize the release for the user and ask for confirmation.

1. Run git diff --stat and git status to gather all pending changes.
2. Compare $VERSION against the latest git tag (git describe --tags --abbrev=0) to determine the bump type (major/minor/patch).
3. Present a summary to the user including:
   • The version being released and the bump type
   • List of files that will be committed
   • Quality check results
4. Wait for user confirmation before proceeding.

Step 6: Commit, Push Branch, and Create PR

git add pyproject.toml
git commit -m "chore: bump version to ${VERSION}"
git push -u origin release/${VERSION}
gh pr create --title "Release v${VERSION}" --body "Release version ${VERSION}"

Include any other changed files (generated code, lock files) in the commit.

The remaining steps (publish, tag, GitHub release) should be performed after the PR is merged to main.

Step 7: Build and Publish to PyPI

After the PR is merged, switch back to main and pull:

git checkout main && git pull origin main
rm -rf dist/ build/
python -m build

Before publishing, show the built artifacts (ls -lh dist/) and ask the user to confirm before running twine upload, since PyPI publishes are effectively irreversible.

Check if PyPI auth is available (look for ~/.pypirc or TWINE_USERNAME env var). If auth is not configured, instruct the user to run the upload manually in their own terminal:

twine upload dist/*

Step 8: Tag the Release

git tag -a v${VERSION} -m "Release version ${VERSION}"
git push origin v${VERSION}

Step 9: Create GitHub Release

gh release create v${VERSION} --title "v${VERSION}" --generate-notes

Or manually:

• Go to the GitHub Releases page
• Click "Create a new release"
• Select the tag you just created
• Add release notes describing the changes
• Publish the release

Quick Reference Checklist

Release v${VERSION}:
- [ ] Preflight: clean working tree
- [ ] Update version in pyproject.toml and derive VERSION from it
- [ ] Create release/${VERSION} branch
- [ ] Regenerate gRPC code if needed (buf generate)
- [ ] Run black, flake8, example imports, pytest
- [ ] Build succeeds (python -m build)
- [ ] Documentation audit (optional, check examples + services in README)
- [ ] Review changes and get user confirmation
- [ ] Commit, push branch, create PR
- [ ] Merge PR to main
- [ ] Clean build, confirm with user, publish to PyPI
- [ ] Create and push git tag (v${VERSION})
- [ ] Create GitHub release