One Time Setup

# Clone the repository
git clone git@github.com:edx/learner-pathway-progress.git
cd learner-pathway-progress

# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.12 learner-pathway-progress

Every time you develop something in this repo

# Activate the virtualenv
workon learner-pathway-progress

# Grab the latest code
git checkout master
git pull

# Install/update the dev requirements
make requirements

# Run the tests and quality checks (to verify the status before you make any changes)
make validate

# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>

# Using your favorite editor, edit the code to make your change.
vim …

# Run your new tests
pytest ./path/to/new/tests

# Run all the tests and quality checks
make validate

# Commit all your changes
git commit …
git push

# Open a PR and ask for review.

Unreleased

[2.1.0] - 2026-10-12

• Added support for Python 3.11 and Django 4.2 so the package can be installed in edxapp (LMS).

• Supported: Python 3.11, 3.12; Django 4.2, 5.2.

• Requirements are now compiled with Python 3.11 and Django 4.2 (the oldest supported versions).

[2.0.0] - 2026-09-28

• Breaking change: Dropped support for Python 3.8 and Django 3.2/4.0.

• Added support for Python 3.12 and Django 5.2 (LTS).

• Regenerated pinned requirements files for the new Python/Django baseline.

[1.4.0]- 2024-11-06

• Deprecated edx-sphinx-theme and replaced it with sphinx-book-theme

[1.3.4]- 2023-06-16

• Added management command to update existing LearnerPathwayProgress table.

[1.3.3]- 2022-10-07

• Added a data migration to delete data for LearnerEnterprisePathwayMembership and LearnerPathwayProgress table.

[1.3.2]- 2022-09-07

• Added enterprise with learner pathway membership.

[1.3.1]- 2022-09-01

• Removed default attribute from LearnerPathwayProgress.learner_pathway_uuid field. This field must be provided at the time of instance creation.

[1.3.0]- 2022-08-11

• Added endpoint for LearnerPathwayProgress model.

[1.2.3]- 2022-07-14

• Update the pathway progress type.

[1.2.2]- 2022-07-05

• Added waffle flag on the top of signals code.

[1.2.1]- 2022-06-20

• Update signal to accept CourseLocator as course_key.

[1.2.0]- 2022-06-10

• Add management command and signal to update learner pathway progress and membership.

[1.1.0] - 2022-06-02

[1.0.1] - 2022-06-01

[1.0.0] - 2022-06-01