Skip to content

Modernize Python repo: pyproject.toml + uv + semantic-release#388

Open
salman2013 wants to merge 13 commits into
openedx:masterfrom
salman2013:salman/modernize-repo
Open

Modernize Python repo: pyproject.toml + uv + semantic-release#388
salman2013 wants to merge 13 commits into
openedx:masterfrom
salman2013:salman/modernize-repo

Conversation

@salman2013

@salman2013 salman2013 commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Modernizes the Python tooling for DoneXBlock 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 human.

salman2013 and others added 3 commits July 13, 2026 15:00
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@openedx-webhooks 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 13, 2026
@openedx-webhooks

openedx-webhooks commented Jul 13, 2026

Copy link
Copy Markdown

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.

salman2013 and others added 2 commits July 13, 2026 17:01
… codecov

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

codecov Bot commented Jul 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 54.54%. Comparing base (4d6ad59) to head (48fda12).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #388      +/-   ##
==========================================
- Coverage   55.35%   54.54%   -0.82%     
==========================================
  Files           3        2       -1     
  Lines          56       55       -1     
  Branches        0        2       +2     
==========================================
- Hits           31       30       -1     
  Misses         25       25              
Flag Coverage Δ
unittests 54.54% <100.00%> (-0.82%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jul 13, 2026
@salman2013
salman2013 marked this pull request as ready for review July 14, 2026 14:48
@salman2013
salman2013 marked this pull request as draft July 14, 2026 14:48
`__package__` resolves to "done" but the distribution name is "done-xblock",
causing PackageNotFoundError at import time in CI.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@salman2013
salman2013 marked this pull request as ready for review July 14, 2026 14:52
@irfanuddinahmad

Copy link
Copy Markdown

👋 Reviewed this against the same checklist we've been applying across the modernization effort. Nothing blocking — CI is fully green — just two small things worth a look:

1. pypa/gh-action-pypi-publish@release/v1 is a floating branch ref, not a pinned SHA. Same issue flagged on the other PRs in this batch — this is what caused openedx/xblocks-core's release to fail with docker: manifest unknown (https://github.com/openedx/xblocks-core/actions/runs/29327012856/job/87066591905). Worth pinning to a commit SHA. (Filed the same fix upstream: openedx/sample-plugin#54.)

2. fallback_version = "0.0.0.dev0" in [tool.setuptools_scm] — checked whether this could hit the same crash we found on openedx-events (that repo's fallback_version had the identical value, and a runtime .split(".")/int() parse of __version__ crashed 17 tests when it was hit). Confirmed done/__init__.py's __version__ isn't consumed anywhere else in this codebase, so it's safe here — no action needed, just flagging why the value looked familiar.

Non-blocking: major_on_zero/allow_zero_version aren't set in [tool.semantic_release] here — since this repo is already at 3.0.0 it'd be a no-op either way, but worth adding for consistency with the rest of the batch (protects against ever auto-jumping to 1.0.0 if the version is reset).

salman2013 and others added 2 commits July 17, 2026 21:57
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@salman2013
salman2013 force-pushed the salman/modernize-repo branch from f53a032 to 48fda12 Compare July 17, 2026 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

4 participants