From 3bf6d0f136f25798ff807f6a4516e413ba945d90 Mon Sep 17 00:00:00 2001 From: Samuel Allan Date: Tue, 28 Jul 2026 10:05:01 +0930 Subject: [PATCH] feat!: simplify dependencies and abandon We're no longer maintaining this, so we don't want to deal with the automated dependency upgrade PRs. Also simplify the dependencies in setup.py, so it will be installable in newer Open edX platform releases without version conflicts. However, note that things could stop working at some point due to incompatibilities anyway. Also pin setuptools to < 82 to retain `pkg_resources`. Ref. https://setuptools.pypa.io/en/stable/history.html#v82-0-0 This should keep it installable at least for Verawood for now. Ref: https://github.com/open-craft/problem-builder/pull/483 Private-ref: https://tasks.opencraft.com/browse/SE-6622 --- .../workflows/upgrade-python-requirements.yml | 29 -------- README.md | 8 +-- setup.py | 72 ++----------------- 3 files changed, 10 insertions(+), 99 deletions(-) delete mode 100644 .github/workflows/upgrade-python-requirements.yml diff --git a/.github/workflows/upgrade-python-requirements.yml b/.github/workflows/upgrade-python-requirements.yml deleted file mode 100644 index 15ebecbe..00000000 --- a/.github/workflows/upgrade-python-requirements.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: Upgrade Python Requirements - -on: - schedule: - - cron: "0 0 * * 1" - workflow_dispatch: - inputs: - branch: - description: Target branch against which to create requirements PR - required: true - default: master - -jobs: - call-upgrade-python-requirements-workflow: - uses: openedx/.github/.github/workflows/upgrade-python-requirements.yml@master - # Do not run on forks - if: github.repository_owner == 'open-craft' - with: - branch: ${{ github.event.inputs.branch || 'master' }} - # optional parameters below; fill in if you'd like github or email notifications - # user_reviewers: "" - # team_reviewers: "" - # email_address: "" - send_success_notification: false - secrets: - requirements_bot_github_token: ${{ secrets.REQUIREMENTS_BOT_GITHUB_TOKEN }} - requirements_bot_github_email: ${{ secrets.REQUIREMENTS_BOT_GITHUB_EMAIL }} - edx_smtp_username: ${{ secrets.EDX_SMTP_USERNAME }} - edx_smtp_password: ${{ secrets.EDX_SMTP_PASSWORD }} diff --git a/README.md b/README.md index 9ad4d8a8..eeed5506 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ > [!WARNING] -> Problem Builder is no longer being developed by OpenCraft. -> It will be supported with compatibility and security fixes -> till the Ulmo release, after which this repository will be -> stop receiving further updates and eventually be archived. +> Problem Builder is unmaintained. +> There will be no further updates, and eventually this repository will be archived. +> This may no longer work correctly on Open edX platform releases newer than Ulmo. +> See https://discuss.openedx.org/t/deprecation-removal-problem-builder-repository/13664 for more information. ## Problem Builder and Step Builder diff --git a/setup.py b/setup.py index f92809d2..c6dec1ee 100644 --- a/setup.py +++ b/setup.py @@ -42,71 +42,6 @@ def get_version(*file_paths): raise RuntimeError('Unable to find version string.') -def load_requirements(*requirements_paths): - """ - Load all requirements from the specified requirements files. - - Requirements will include any constraints from files specified - with -c in the requirements files. - Returns a list of requirement strings. - """ - requirements = {} - constraint_files = set() - - # groups "pkg<=x.y.z,..." into ("pkg", "<=x.y.z,...") - requirement_line_regex = re.compile(r"([a-zA-Z0-9-_.]+)([<>=][^#\s]+)?") - - def add_version_constraint_or_raise(current_line, current_requirements, add_if_not_present): - regex_match = requirement_line_regex.match(current_line) - if regex_match: - package = regex_match.group(1) - version_constraints = regex_match.group(2) - existing_version_constraints = current_requirements.get(package, None) - # fine to add constraints to an unconstrained package, - # raise an error if there are already constraints in place - if existing_version_constraints and existing_version_constraints != version_constraints: - raise BaseException( - f'Multiple constraint definitions found for {package}:' - f' "{existing_version_constraints}" and "{version_constraints}".' - f'Combine constraints into one location with {package}' - f'{existing_version_constraints},{version_constraints}.' - ) - if add_if_not_present or package in current_requirements: - current_requirements[package] = version_constraints - - # read requirements from .in - # store the path to any constraint files that are pulled in - for path in requirements_paths: - with open(path) as reqs: - for line in reqs: - if is_requirement(line): - add_version_constraint_or_raise(line, requirements, True) - if line and line.startswith('-c') and not line.startswith('-c http'): - constraint_files.add(os.path.dirname(path) + '/' + line.split('#')[0].replace('-c', '').strip()) - - # process constraint files: add constraints to existing requirements - for constraint_file in constraint_files: - with open(constraint_file) as reader: - for line in reader: - if is_requirement(line): - add_version_constraint_or_raise(line, requirements, False) - - # process back into list of pkg><=constraints strings - constrained_requirements = [f'{pkg}{version or ""}' for (pkg, version) in sorted(requirements.items())] - return constrained_requirements - - -def is_requirement(line): - """ - Return True if the requirement line is a package requirement. - - Returns: - bool: True if the line is not blank, a comment, - a URL, or an included file - """ - return line and line.strip() and not line.startswith(("-r", "#", "-e", "git+", "-c")) - - def package_data(pkg, roots): """Generic function to find package_data. @@ -184,7 +119,12 @@ def package_data(pkg, roots): exclude=["*tests"], ), package_data=package_data("problem_builder", ["templates", "public", "translations"]), - install_requires=load_requirements('requirements/base.in'), + install_requires=[ + "xblock-utils", + "edx-opaque-keys", + "Django", + "setuptools<82", + ], python_requires=">=3.11", keywords='Python edx', entry_points={