Skip to main content

A plugin to track learners progress in pathways.

Project description

PyPI CI Codecov Documentation Supported Python versions License

Overview

Learner-pathway-progress is a plugin that is supposed to be installed inside the edx-platform and integrated in lms, it contains the code to track the progress of learners in learner pathways.

Development Workflow

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.8 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.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome. Please read How To Contribute for details. Even though they were written with edx-platform in mind, the guidelines should be followed for all Open edX projects.

The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you can find it at PULL_REQUEST_TEMPLATE.md.

The issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you can find it at ISSUE_TEMPLATE.md.

Reporting Security Issues

Please do not report security issues in public. Please email security@edx.org.

Getting Help

If you’re having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.

For more information about these options, see the Getting Help page.

Change Log

Unreleased

[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

Added

  • entry point for app

  • app_label in model

Changed

  • Plugin app configuration

[1.0.1] - 2022-06-01

Fixed

  • Version in __init__.py

Changed

  • name of package in setup.py file

[1.0.0] - 2022-06-01

Added

  • Basic skeleton of the app.

  • LearnerPathwayMembership model.

Changed

  • main branch from main to master

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

learner-pathway-progress-1.2.2.tar.gz (29.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

learner_pathway_progress-1.2.2-py2.py3-none-any.whl (29.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file learner-pathway-progress-1.2.2.tar.gz.

File metadata

File hashes

Hashes for learner-pathway-progress-1.2.2.tar.gz
Algorithm Hash digest
SHA256 d04f64c4792c86a0a5e6d758263cb6246b33a16c3e524fe1030e7e363e276033
MD5 7ce39c8df6e67a9fa4623f3796fad2e3
BLAKE2b-256 04d8c1f7bb04b4cf7afdfe69430bf98fcc4e3f6206063340c4c240f3355a09f6

See more details on using hashes here.

File details

Details for the file learner_pathway_progress-1.2.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for learner_pathway_progress-1.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1790673560376c95bd25979193272b307f25a12a39e90557425006a17ca5906f
MD5 9b221a981ab2206537723ba62cf66bc9
BLAKE2b-256 27f516a8fa7ecef9f576e41274c40bd435464892eb636aabcea0d95a5788502d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page