Modernize python tooling by salman2013 · Pull Request #519 · openedx/xblock-sdk

salman2013 · 2026-07-14T19:19:24Z

Modernizes the Python tooling for this repo in three phases, aligning with the Open edX org standard established in openedx/sample-plugin.

Ticket: openedx/public-engineering#511
Parent ticket: openedx/public-engineering#506

Changes generated by Claude Sonnet 4.6 using the modernize-python-tooling skill, reviewed by a human.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

openedx-webhooks · 2026-07-14T19:19:30Z

Thanks for the pull request, @salman2013!

This repository is currently maintained by @openedx/axim-engineering.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Populates [tool.uv].constraint-dependencies with setuptools<82.0 and common constraints so uv.lock pins setuptools to <82 (required by openedx-django-pyfs which uses pkg_resources). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

mphilbrick211 · 2026-07-15T14:44:10Z

@openedx/axim-engineering this is ready for review. Thanks!

irfanuddinahmad · 2026-07-16T12:33:39Z

👋 Reviewed this against the same checklist we've been applying across the modernization effort (openedx/public-engineering#506/#511/#513/#514). A couple of things worth fixing before merge:

1. Old pypi-publish.yml is still active and will race with the new release.yml. This PR adds release.yml (OIDC-based, triggered by conventional commits on master) but doesn't remove the pre-existing .github/workflows/pypi-publish.yml, which triggers on push: tags: '*'. Once this merges and semantic-release pushes its first version tag, both workflows will fire and race to publish the same version via two different auth mechanisms (old token vs. new OIDC) — recommend deleting pypi-publish.yml as part of this PR.

2. pypa/gh-action-pypi-publish@release/v1 is a floating branch ref, not a pinned SHA. This is exactly what caused openedx/xblocks-core's release to fail with docker: manifest unknown (https://github.com/openedx/xblocks-core/actions/runs/29327012856/job/87066591905) — the ref resolved to a commit whose Docker image wasn't published on ghcr.io yet. Worth pinning to a commit SHA like the rest of this workflow's actions already are. (This traces back to openedx/sample-plugin's own reference release.yml, which has the same gap — filed openedx/sample-plugin#54 and openedx/xblocks-core#280 for that.)

Minor/non-blocking: codecov/project is currently failing — real tests and codecov/patch (100%) pass, looks like a coverage-threshold comparison issue rather than a functional problem.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

farhan

Improvements:

CHANGELOG.rst not deleted — for PyPI repos (release gate passed), CHANGELOG.rst should be deleted because python-semantic-release takes over release notes. The file is also still listed in MANIFEST.in. — this is an absent deletion.
.github/workflows/pypi-publish.yml not deleted — this workflow fires on every tag push and will conflict with release.yml, causing duplicate publish attempts.

farhan · 2026-07-21T09:35:47Z

@@ -0,0 +1,161 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools-scm>=8.0"]


We had a discussion on it.
It's not a blocker.

farhan · 2026-07-21T09:35:47Z

+"workbench" = ["static/**/*", "templates/**/*", "test/**/*"]
+
+[tool.setuptools.exclude-package-data]
+"*" = ["tests*", "*.tests*", "spec*", "*.spec*"]


The pattern "tests*" does not match directories named test/ (singular). The test dirs in this repo (workbench/test/, sample_xblocks/basic/test/) use the singular form, so they appear in the built wheel. Add "test*" and "*.test*":

"*" = ["test*", "tests*", "*.test*", "*.tests*", "spec*", "*.spec*"]

farhan · 2026-07-21T09:35:47Z

+
+[tool.coverage.run]
+branch = true
+source = ["."]


After the src/ move, source = ["."] measures coverage from the repo root rather than the installed packages. Use source_pkgs instead:

source_pkgs = ["workbench", "sample_xblocks"]

This ensures pytest-cov targets the installed package under src/ rather than unrelated root-level files.

farhan · 2026-07-21T09:35:48Z

+branch = true
+source = ["."]
+omit = [
+    "workbench/test/*",


The omit paths here (and on the next line) use the pre-src/ layout. After the move, test files live at src/workbench/test/* and src/sample_xblocks/*/test/*, so these patterns will not match and test-helper code will be included in coverage:

omit = [ "src/workbench/test/*", "src/sample_xblocks/*/test/*", "*/migrations/*", "*/__pycache__/*", "*/settings.py", ]

farhan · 2026-07-21T09:35:48Z

-__version__ = '0.14.0'
+from importlib.metadata import version
+
+__version__ = version("xblock-sdk")


importlib.metadata.version() raises PackageNotFoundError on any checkout that hasn't been pip install -e .'d. Wrap with a fallback:

from importlib.metadata import version, PackageNotFoundError try: __version__ = version("xblock-sdk") except PackageNotFoundError: __version__ = "0.0.0"

farhan · 2026-07-21T09:35:48Z

+
+      - name: Upload dist artifacts
+        if: steps.release.outputs.released == 'true'
+        uses: actions/upload-artifact@v4


actions/upload-artifact@v4 is a floating tag. Pin to a SHA with a version comment for supply-chain security, consistent with actions/checkout and setup-uv elsewhere in this PR.

farhan · 2026-07-21T09:35:48Z

+
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4


actions/download-artifact@v4 is a floating tag. Pin to a SHA with a version comment, same as the upload step above.

farhan · 2026-07-21T13:03:50Z

@@ -1,33 +1,33 @@
 name: Python CI
 on:
-  push:


The push: branches: [master] trigger was removed.

Is this intentional?

salman2013 and others added 3 commits July 15, 2026 00:17

chore: migrate package metadata to pyproject.toml (PEP 621)

f0ad6da

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

chore: switch dependency management from pip-tools to uv

eb6a9c7

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

chore: add python-semantic-release and commitlint workflows

4dd760c

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jul 14, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Jul 14, 2026

openedx-webhooks added this to Contributions Jul 14, 2026

salman2013 mentioned this pull request Jul 14, 2026

Modernize Python repo | XBlocks openedx/public-engineering#511

Open

16 tasks

salman2013 and others added 2 commits July 15, 2026 00:27

fix: add blank line in workbench/__init__.py to satisfy isort

a6f42e9

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jul 15, 2026

chore: switch PyPI publishing to OIDC trusted publisher

2ed3161

salman2013 and others added 2 commits July 17, 2026 21:58

refactor: migrate to src layout

600a60a

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

chore: standardize release.yml workflow

6bad88d

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

salman2013 force-pushed the salman/modernize-python-tooling branch from 24e1715 to 6bad88d Compare July 17, 2026 17:34

farhan self-requested a review July 21, 2026 09:08

farhan requested changes Jul 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Modernize python tooling#519

Modernize python tooling#519
salman2013 wants to merge 8 commits into
openedx:masterfrom
salman2013:salman/modernize-python-tooling

salman2013 commented Jul 14, 2026

Uh oh!

openedx-webhooks commented Jul 14, 2026

Uh oh!

mphilbrick211 commented Jul 15, 2026

Uh oh!

irfanuddinahmad commented Jul 16, 2026

Uh oh!

farhan left a comment •

edited

Loading

Uh oh!

farhan Jul 21, 2026

Uh oh!

farhan Jul 21, 2026

Uh oh!

farhan Jul 21, 2026

Uh oh!

farhan Jul 21, 2026

Uh oh!

farhan Jul 21, 2026

Uh oh!

farhan Jul 21, 2026

Uh oh!

farhan Jul 21, 2026

Uh oh!

farhan Jul 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		@@ -0,0 +1,161 @@
		[build-system]
		requires = ["setuptools>=64", "setuptools-scm>=8.0"]

Uh oh!

Conversation

salman2013 commented Jul 14, 2026

Uh oh!

openedx-webhooks commented Jul 14, 2026

Uh oh!

mphilbrick211 commented Jul 15, 2026

Uh oh!

irfanuddinahmad commented Jul 16, 2026

Uh oh!

farhan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

farhan left a comment •

edited

Loading