Skip to content

build: update python requirements - #706

Open
iloveagent57 wants to merge 1 commit into
masterfrom
aed/requirements
Open

build: update python requirements#706
iloveagent57 wants to merge 1 commit into
masterfrom
aed/requirements

Conversation

@iloveagent57

@iloveagent57 iloveagent57 commented Aug 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
  1. reran edx_lint write pylintrc to get the pii_terms sections.
  2. pinned new pip-related constraints.
  3. updates the PR template to align with reality.

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in Travis, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in edx-analytics-data-api to upgrade dependencies (including edx-enterprise-data)
    • This must be done after the version is visible in PyPi as make upgrade in edx-analytics-data-api will look for the latest version in PyPi.
    • Note: the edx-enterprise-data constraint in edx-analytics-data-api must also be bumped to the latest version in PyPi.

@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 Aug 25, 2026
@openedx-webhooks

openedx-webhooks commented Aug 25, 2026

Copy link
Copy Markdown

Thanks for the pull request, @iloveagent57!

This repository is currently maintained by @openedx/2u-enterprise.

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Aug 25, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Aug 26, 2026
@iloveagent57
iloveagent57 force-pushed the aed/requirements branch 2 times, most recently from 12107b1 to 33eff4d Compare August 26, 2026 20:02
brobro10000
brobro10000 approved these changes Aug 31, 2026
View reviewed changes

@brobro10000 brobro10000 left a comment

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.

Approved to unblock. Please remove constraints now handled upstream in edx-lint. pip-tools no longer has to be pinned.

Comment thread requirements/common_constraints.txt
Comment on lines +29 to +44
# 2026-08-11: pip-tools is only tested against the latest pip released at the time
# pip-tools was released; also, pip-tools package dependencies are extremely permissive
# about the pip version required, so the dependency resolver will not prevent an unwanted
# pip upgrade which would break pip-tools. The end result is that pip MUST be constrained
# by all pip-tools users in order to avoid potentially weeks-long lapses in pip <->
# pip-tools compatibility. We've constrained pip here in common_constraints.txt in the
# past, but always removed it once the issue was "fixed". Removing this constraint was
# always a mistake.
#
# This is a semi-permanent constraint and should be manually bumped after each pip-tools
# release.
#
# Exceptional conditions for removal:
# - We stop using pip-tools, OR
# - We migrate to the proposed `pip-tools[stable]` extra: https://github.com/jazzband/pip-tools/pull/2257
pip<26.2.1 # Known to work with pip-tools==7.6.1

@brobro10000 brobro10000 Aug 31, 2026

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.

This is now pinned in edx-lint as part of the 6.2.0 upgrade and can now be removed from individual repos.
PR: openedx/edx-lint#564

Comment thread requirements/constraints.txt
Comment on lines +35 to +43
# pip 26.2+ is incompatible with pip-tools 7.6.0 (latest pip-tools release only
# supports pip up to 26.1), which breaks `make upgrade`. Remove this once a
# newer pip-tools release restores pip 26.2+ compatibility.
pip<26.2

# Pin pip-tools to the version verified compatible with the pip<26.2 constraint
# above; a newer pip-tools release could require a newer pip and reintroduce
# the `make upgrade` breakage this constraint set was added to fix.
pip-tools==7.6.0

@brobro10000 brobro10000 Aug 31, 2026

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.

Pinning pip-tools is no longer required, and these 2 constraints can be removed. The reasoning why pip-tools can be unpinned alludes me.
See this edx-lint PR for more context why: openedx/edx-lint#564 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@brobro10000 brobro10000 brobro10000 approved these changes

Assignees

No one assigned

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

Contributions
Status: Waiting on Author

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@iloveagent57 @openedx-webhooks @brobro10000 @mphilbrick211