Skip to content

chore: modernize Python tooling (uv, PEP 621, semantic-release, src layout)#265

Open
salman2013 wants to merge 5 commits into
openedx:masterfrom
salman2013:modernize-python-tooling
Open

chore: modernize Python tooling (uv, PEP 621, semantic-release, src layout)#265
salman2013 wants to merge 5 commits into
openedx:masterfrom
salman2013:modernize-python-tooling

Conversation

@salman2013

Copy link
Copy Markdown
Contributor

Summary

  • Phase 1: Migrate package metadata to pyproject.toml (PEP 621) — removed setup.py, added setuptools-scm for dynamic versioning, coverage config, importlib.metadata for __version__
  • Phase 2: Switch dependency management from pip-tools/requirements/*.txt to uv + uv.lock with [dependency-groups]; update tox.ini to use tox-uv/uv-venv-lock-runner; update CI to use astral-sh/setup-uv
  • Phase 3: Add python-semantic-release workflow for automated PyPI publishing via OIDC trusted publisher; add commitlint workflow to enforce conventional commits
  • Phase 4: Migrate to src/ layout — moved image_explorer/ to src/image_explorer/

Test plan

  • uv run tox -e quality — pylint 9.45/10, passes
  • uv run tox -e py312-django42 — 6/6 tests passed
  • uv run tox -e py312-django52 — 6/6 tests passed
  • Configure OIDC trusted publisher on PyPI for openedx/xblock-image-explorer (publisher: GitHub Actions, workflow: release.yml)

🤖 Generated with Claude Code

salman2013 and others added 4 commits July 17, 2026 12:18
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>
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 17, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @salman2013!

This repository is currently maintained by @Agrendalath.

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.

The translations/ directory is a symlink to conf/locale. Setuptools skips
symlinks when building sdists, causing the wheel build to fail with
"doesn't exist or not a regular file". Also remove stale requirements/
references from MANIFEST.in.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants