chore: update to Python 3.11/3.12 and Django 4.2/5.2 by Gi-ron · Pull Request #13 · eduNEXT/openedx-cas

Gi-ron · 2026-03-26T23:00:19Z

Description

This PR updates the openedx-cas plugin to support Open edX Teak release, which runs on Python 3.11/3.12 and Django 4.2/5.2. It also removes support for older Python and Django versions.

The update includes:

Dependency upgrades to match the new platform requirements.
Updates to tox and GitHub Actions matrices.
Bump of version to 0.3.0.
Updated changelog and documentation.

Changes

Added

Support for Python 3.11 and 3.12.
Support for Django 4.2 and 5.2.
New GitHub Actions test matrix with the supported Python/Django combinations.
Set DJANGO_SETTINGS_MODULE in the quality tox environment to avoid pylint configuration errors.

Changed

Updated social-auth-core from 4.1.0 to 4.8.5.
Upgraded all dependencies via make upgrade.
Updated GitHub workflows (ci.yml, pypi-publish.yml) to use recent action versions.
Updated tox.ini to test against the new Python and Django versions.
Updated classifiers in setup.py to reflect Python 3.11/3.12 and Django 4.2/5.2.
Updated README.rst compatibility table to include Teak.

Removed

Dropped support for Python 3.8.
Dropped support for Django 2.2, 3.2, and 4.0.
Removed obsolete pylint options (regenerated .pylintrc with edx-lint).

Fixed

Fixed pylint warnings in setup.py by using with statements for file operations.
Fixed tox.ini to allow external commands in the quality environment.

Local Testing on Teak Instance

To validate the plugin works correctly in a real Open edX Teak environment, I performed the following steps on a local Tutor instance (Teak release):

Create a Teak environment

  pip install "tutor[full]>=20.0.0,<21.0.0"
  export TUTOR_ROOT=$PWD
  export TUTOR_PLUGINS_ROOT=$PWD/plugins
  tutor local launch

Install the plugin from this branch

   OPENEDX_EXTRA_PIP_REQUIREMENTS:
   - git+https://github.com/eduNEXT/openedx-cas.git@sgb/upgrade-python-django-versions

Apply database migrations

   tutor local exec lms python manage.py lms migrate openedx_cas

Configure a CAS provider via Django admin

Navigated to http://local.openedx.io:8000/admin/openedx_cas/casproviderconfig/
Created a new provider with test settings (e.g., name, URL, etc.)
Saved the configuration successfully – no errors or missing fields.

Screenshot of the provider list:

The LMS logs showed no exceptions related to openedx_cas

Versioning

Current version: 0.3.0
Previous version: 0.2.4

The version has been bumped to minor because new Python and Django versions are supported and backward compatibility with older releases is dropped.

Checklist

Dependencies updated (make upgrade).
Tox matrix updated.
GitHub Actions workflows updated.
setup.py classifiers updated.
README.rst compatibility table updated.
CHANGELOG.rst updated.
Version bumped to 0.3.0.
Quality checks (tox -e quality) pass.
Tests pass for all supported combinations.

requirements/ci.txt

magajh · 2026-03-31T20:04:43Z

@Gi-ron, regarding the local testing section you added in the PR description:

Local testing with tox

Run the following commands to verify the plugin works with all supported combinations:

tox -e py311-django42
tox -e py311-django52
tox -e py312-django42
tox -e py312-django52
tox -e quality

I don’t think this adds much value here, since these exact test combinations are already running in GitHub Actions and we already know they are passing.

What we really need to validate locally before merging is the plugin behavior in a real Open edX instance: install it in a Teak instance, verify that it installs cleanly, confirm there are no runtime errors, and test that the plugin actually works as expected there.

Have you tested it on your side by installing the plugin in a Teak instance and verifying that everything works correctly without errors? I think that is the validation we still need before merging this PR.

Gi-ron · 2026-03-31T20:28:48Z

@Gi-ron, regarding the local testing section you added in the PR description:
Local testing with tox

Run the following commands to verify the plugin works with all supported combinations:

tox -e py311-django42
tox -e py311-django52
tox -e py312-django42
tox -e py312-django52
tox -e quality
I don’t think this adds much value here, since these exact test combinations are already running in GitHub Actions and we already know they are passing.

What we really need to validate locally before merging is the plugin behavior in a real Open edX instance: install it in a Teak instance, verify that it installs cleanly, confirm there are no runtime errors, and test that the plugin actually works as expected there.

Have you tested it on your side by installing the plugin in a Teak instance and verifying that everything works correctly without errors? I think that is the validation we still need before merging this PR.

@magajh Sure, i updated the description to provide a series of steps on how to test locally.

magajh

Thanks @Gi-ron for this work

magajh · 2026-03-31T18:42:22Z

.github/workflows/ci.yml

+        toxenv: [
+          'py311-django42',
+          'py311-django52',
+          'py312-django42',


I’m not sure we need to include the Python 3.12 / Django 4.2 combination here, since I don't think any supported Open edX version runs on it. Looks like testing Python 3.12 with only Django 5.2 would be enough

@Gi-ron you closed this comment but we still have 'py312-django42' listed here

magajh · 2026-03-31T18:59:07Z

.github/workflows/ci.yml

-    - name: Install pip
-      run: pip install -r requirements/pip.txt
-
+        python-version: ${{ matrix.toxenv == 'py311-django42' && '3.11' || matrix.toxenv == 'py311-django52' && '3.11' || matrix.toxenv == 'py312-django42' && '3.12' || matrix.toxenv == 'py312-django52' && '3.12' || '3.11' }}


I think this would be cleaner if we defined the supported environments explicitly in the matrix instead of deriving the Python version from toxenv in one long expression. Since we only support a fixed set of combinations, using matrix.include makes the workflow much easier to read and maintain

matrix: include: - python-version: "3.11" toxenv: "py3.11-django4.2" - python-version: "3.11" toxenv: "py3.11-django5.2" - python-version: "3.12" toxenv: "py3.12-django5.2"

@Gi-ron this comment is closed but this has not been solved yet

.github/workflows/ci.yml

magajh · 2026-03-31T19:20:39Z

.github/workflows/commitlint.yml

+        with:
+          fetch-depth: 100
+
+      - name: Download configuration


@Gi-ron I’m curious why this step and the related changes in this action are needed now. Was the action not working properly before?

The issue was that the default configuration file (downloaded from openedx/edx-lint) uses ES module syntax (export default), but the action expects CommonJS (module.exports). This caused a syntax error when the action tried to run. I’m not entirely sure if this failure was already present before (I didn’t run the action on previous commits)

@Gi-ron are we sure there is not a cleaner way to run this workflow?
If not, I'm ok with merging this but first I would like us to do a double check

.github/workflows/pypi-publish.yml

CHANGELOG.rst

setup.cfg

tox.ini

magajh · 2026-03-31T20:38:38Z

@Gi-ron can we please add a compatibility notes table here like we've done for the other plugins? https://github.com/eduNEXT/eox-hooks?tab=readme-ov-file#compatibility-notes

This new version is compatible for releases Sumac, Teak and Ulmo and the previous version is compatible with releases <=Redwood

magajh

@Gi-ron seems like they are still pending changes, please double check all the comments I left in my first review

magajh · 2026-04-01T20:18:10Z

.github/workflows/ci.yml

+        toxenv: [
+          'py311-django42',
+          'py311-django52',
+          'py312-django42',


@Gi-ron you closed this comment but we still have 'py312-django42' listed here

magajh · 2026-04-01T20:18:59Z

.github/workflows/ci.yml

-    - name: Install pip
-      run: pip install -r requirements/pip.txt
-
+        python-version: ${{ matrix.toxenv == 'py311-django42' && '3.11' || matrix.toxenv == 'py311-django52' && '3.11' || matrix.toxenv == 'py312-django42' && '3.12' || matrix.toxenv == 'py312-django52' && '3.12' || '3.11' }}


@Gi-ron this comment is closed but this has not been solved yet

.github/workflows/ci.yml

README.rst

magajh

@Gi-ron, thanks for the work on this.

If we already tested the installation in a Teak environment with these latest changes and we’re confident it installs correctly without issues, then feel free to go ahead and merge it and release the new version.

I left one last comment about the commitlint flow, but I don’t consider it a blocker, so I’m approving this anyway

magajh · 2026-04-01T21:57:02Z

.github/workflows/commitlint.yml

+        with:
+          fetch-depth: 100
+
+      - name: Download configuration


@Gi-ron are we sure there is not a cleaner way to run this workflow?
If not, I'm ok with merging this but first I would like us to do a double check

Gi-ron force-pushed the sgb/upgrade-python-django-versions branch 2 times, most recently from 916aee1 to aba45ba Compare March 30, 2026 13:36

magajh requested review from jignaciopm and magajh March 30, 2026 15:06

magajh requested changes Mar 30, 2026

View reviewed changes

requirements/ci.txt Outdated Show resolved Hide resolved

Gi-ron closed this Mar 31, 2026

Gi-ron added 3 commits March 30, 2026 23:26

feat: add support for Python 3.11/3.12 and Django 4.2/5.2

9a8ec7e

fix: commitlint workflow

4e5392a

fix: update matrix ubuntu version

5a56827

Gi-ron reopened this Mar 31, 2026

Gi-ron force-pushed the sgb/upgrade-python-django-versions branch from aba45ba to 5a56827 Compare March 31, 2026 14:37

Gi-ron closed this Mar 31, 2026

Gi-ron reopened this Mar 31, 2026

feat: upgrade pip and setuptools in workflow

48b2e9d

magajh self-requested a review March 31, 2026 18:39

magajh requested changes Mar 31, 2026

View reviewed changes

feat: adding feedback pr

f5f9e56

magajh self-requested a review April 1, 2026 20:12

magajh requested changes Apr 1, 2026

View reviewed changes

Gi-ron force-pushed the sgb/upgrade-python-django-versions branch from 6f0670b to 69ef4d5 Compare April 1, 2026 21:12

magajh requested changes Apr 1, 2026

View reviewed changes

.github/workflows/ci.yml Outdated Show resolved Hide resolved

.github/workflows/ci.yml Outdated Show resolved Hide resolved

.github/workflows/ci.yml Outdated Show resolved Hide resolved

README.rst Show resolved Hide resolved

Gi-ron force-pushed the sgb/upgrade-python-django-versions branch 2 times, most recently from 234d9f2 to c89582b Compare April 1, 2026 21:29

fix: update ci workflow with correct versions

8fd3e1f

Gi-ron force-pushed the sgb/upgrade-python-django-versions branch from 83ba58c to 8fd3e1f Compare April 1, 2026 21:43

magajh approved these changes Apr 1, 2026

View reviewed changes

Conversation

Gi-ron commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Added

Changed

Removed

Fixed

Local Testing on Teak Instance

Versioning

Checklist

Uh oh!

Uh oh!

magajh commented Mar 31, 2026

Uh oh!

Gi-ron commented Mar 31, 2026

Uh oh!

magajh left a comment

Choose a reason for hiding this comment

Uh oh!

magajh Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

magajh commented Mar 31, 2026

Uh oh!

magajh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

magajh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Gi-ron commented Mar 26, 2026 •

edited

Loading

magajh Mar 31, 2026 •

edited

Loading