Skip to content

chore: update readme for verawood dependency#38509

Merged
kdmccormick merged 1 commit intoopenedx:release/verawoodfrom
open-craft:farhaan/verawood-readme
May 5, 2026
Merged

chore: update readme for verawood dependency#38509
kdmccormick merged 1 commit intoopenedx:release/verawoodfrom
open-craft:farhaan/verawood-readme

Conversation

@farhaanbukhsh
Copy link
Copy Markdown
Member

Update the readme for sandbox requirement for verawood.

@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 May 4, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @farhaanbukhsh!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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.

Comment thread requirements/edx-sandbox/README.rst Outdated
---------------------

* Frozen at the time of the Verawood release
* Supports Python 3.11 and Python 3.12
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Supports Python 3.11 and Python 3.12
* Supports Python 3.12

we dropped 3.11 support from the codejail package itself, so this the env will only support 3.12 in verawood

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I add that we dropped support for 3.11?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, good idea, we noted it as a breaking change when we dropped 3.8

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added, thanks @kdmccormick for pointing out.

Comment thread requirements/edx-sandbox/README.rst Outdated
Comment on lines +104 to +105
to newer versions. These upgrades continue improvements for Python 3.12
compatibility and include minor dependency refreshes.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
to newer versions. These upgrades continue improvements for Python 3.12
compatibility and include minor dependency refreshes.
to newer versions. These upgrades continue improvements for Python 3.12
compatibility and include minor dependency refreshes.

in rst, following lines need to match the indentation of the bullet

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed :) thanks!

@farhaanbukhsh farhaanbukhsh force-pushed the farhaan/verawood-readme branch from 5e27f42 to 180b321 Compare May 5, 2026 11:57
@farhaanbukhsh farhaanbukhsh requested a review from kdmccormick May 5, 2026 11:57
Copy link
Copy Markdown
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM as long as you check that it renders correctly first :)

Comment thread requirements/edx-sandbox/README.rst Outdated
Comment on lines +99 to +106
* Frozen at the time of the Verawood release
* BREAKING CHANGE: Drops support for Python 3.11
* Supports Python 3.12
* NumPy is upgraded to 1.26.4
* SciPy is upgraded to 1.17.1
* Several other libraries (such as matplotlib, nltk, sympy) have also been updated
to newer versions. These upgrades continue improvements for Python 3.12
compatibility and include minor dependency refreshes.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indentation is still off. I think this will fix it, please use the Preview / View File tab to check that it looks right!

Suggested change
* Frozen at the time of the Verawood release
* BREAKING CHANGE: Drops support for Python 3.11
* Supports Python 3.12
* NumPy is upgraded to 1.26.4
* SciPy is upgraded to 1.17.1
* Several other libraries (such as matplotlib, nltk, sympy) have also been updated
to newer versions. These upgrades continue improvements for Python 3.12
compatibility and include minor dependency refreshes.
* Frozen at the time of the Verawood release
* BREAKING CHANGE: Drops support for Python 3.11
* Supports Python 3.12
* NumPy is upgraded to 1.26.4
* SciPy is upgraded to 1.17.1
* Several other libraries (such as matplotlib, nltk, sympy) have also been updated
to newer versions. These upgrades continue improvements for Python 3.12
compatibility and include minor dependency refreshes.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙈 let me fix my editor for it, I am really sorry to get so many re-edits for a small change.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all good haha, thanks

Signed-off-by: Farhaan Bukhsh <farhaan@opencraft.com>
@farhaanbukhsh farhaanbukhsh force-pushed the farhaan/verawood-readme branch from 180b321 to 4928234 Compare May 5, 2026 17:07
Copy link
Copy Markdown
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TY!

@kdmccormick kdmccormick merged commit d5499d3 into openedx:release/verawood May 5, 2026
34 of 37 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions May 5, 2026
@kdmccormick
Copy link
Copy Markdown
Member

@farhaanbukhsh This edx-sandbox freezing is meant to be done before the release cutoff, so that future releases will have verawood.txt. Could you forward-port verawood.txt and this readme update to master?

@ormsbee ormsbee mentioned this pull request May 5, 2026
@farhaanbukhsh
Copy link
Copy Markdown
Member Author

@kdmccormick sure, I made the PR before but forgot to merge it 🙈

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: Done

Development

Successfully merging this pull request may close these issues.

3 participants