Learner Pathway Progress
=============================
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge|
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
~~~~~~~~~~~~~~
.. code-block::
# 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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block::
# 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 <LICENSE.txt>`_ for details.
How To Contribute
-----------------
Contributions are very welcome.
Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ 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 <.github/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 <.github/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.
.. _Slack invitation: https://openedx-slack-invite.herokuapp.com/
.. _community Slack workspace: https://openedx.slack.com/
.. _Getting Help: https://openedx.org/getting-help
.. |pypi-badge| image:: https://img.shields.io/pypi/v/learner-pathway-progress.svg
:target: https://pypi.python.org/pypi/learner-pathway-progress/
:alt: PyPI
.. |ci-badge| image:: https://github.com/edx/learner-pathway-progress/workflows/Python%20CI/badge.svg?branch=master
:target: https://github.com/edx/learner-pathway-progress/actions
:alt: CI
.. |codecov-badge| image:: https://codecov.io/github/edx/learner-pathway-progress/coverage.svg?branch=master
:target: https://codecov.io/github/edx/learner-pathway-progress?branch=master
:alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/learner-pathway-progress/badge/?version=latest
:target: https://learner-pathway-progress.readthedocs.io/en/latest/
:alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/learner-pathway-progress.svg
:target: https://pypi.python.org/pypi/learner-pathway-progress/
:alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/edx/learner-pathway-progress.svg
:target: https://github.com/edx/learner-pathway-progress/blob/master/LICENSE.txt
:alt: License
Change Log
----------
..
All enhancements and patches to learner_pathway_progress will be documented
in this file. It adheres to the structure of https://keepachangelog.com/ ,
but in reStructuredText instead of Markdown (for ease of incorporation into
Sphinx documentation and the PyPI description).
This project adheres to Semantic Versioning (https://semver.org/).
.. There should always be an "Unreleased" section for changes pending release.
Unreleased
~~~~~~~~~~
[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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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`
Raw data
{
"_id": null,
"home_page": "https://github.com/edx/learner-pathway-progress",
"name": "learner-pathway-progress",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Python edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/19/88/b19ed8e35cff303e07d6bf18ff0765b67884fe5c8762dc32af9bc6f8e482/learner-pathway-progress-1.3.4.tar.gz",
"platform": null,
"description": "Learner Pathway Progress\n=============================\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge|\n\n\nOverview\n------------------------\nLearner-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.\n\n\nDevelopment Workflow\n--------------------\n\nOne Time Setup\n~~~~~~~~~~~~~~\n.. code-block::\n\n # Clone the repository\n git clone git@github.com:edx/learner-pathway-progress.git\n cd learner-pathway-progress\n\n # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it\n mkvirtualenv -p python3.8 learner-pathway-progress\n\n\nEvery time you develop something in this repo\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. code-block::\n\n # Activate the virtualenv\n workon learner-pathway-progress\n\n # Grab the latest code\n git checkout master\n git pull\n\n # Install/update the dev requirements\n make requirements\n\n # Run the tests and quality checks (to verify the status before you make any changes)\n make validate\n\n # Make a new branch for your changes\n git checkout -b <your_github_username>/<short_description>\n\n # Using your favorite editor, edit the code to make your change.\n vim \u2026\n\n # Run your new tests\n pytest ./path/to/new/tests\n\n # Run all the tests and quality checks\n make validate\n\n # Commit all your changes\n git commit \u2026\n git push\n\n # Open a PR and ask for review.\n\nLicense\n-------\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see `LICENSE.txt <LICENSE.txt>`_ for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome.\nPlease read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.\nEven though they were written with ``edx-platform`` in mind, the guidelines\nshould be followed for all Open edX projects.\n\nThe pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you\ncan find it at `PULL_REQUEST_TEMPLATE.md <.github/PULL_REQUEST_TEMPLATE.md>`_.\n\nThe issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you\ncan find it at `ISSUE_TEMPLATE.md <.github/ISSUE_TEMPLATE.md>`_.\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@edx.org.\n\nGetting Help\n------------\n\nIf you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.\n\nOur real-time conversations are on Slack. You can request a `Slack invitation`_, then join our `community Slack workspace`_.\n\nFor more information about these options, see the `Getting Help`_ page.\n\n.. _Slack invitation: https://openedx-slack-invite.herokuapp.com/\n.. _community Slack workspace: https://openedx.slack.com/\n.. _Getting Help: https://openedx.org/getting-help\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/learner-pathway-progress.svg\n :target: https://pypi.python.org/pypi/learner-pathway-progress/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/edx/learner-pathway-progress/workflows/Python%20CI/badge.svg?branch=master\n :target: https://github.com/edx/learner-pathway-progress/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/edx/learner-pathway-progress/coverage.svg?branch=master\n :target: https://codecov.io/github/edx/learner-pathway-progress?branch=master\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/learner-pathway-progress/badge/?version=latest\n :target: https://learner-pathway-progress.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/learner-pathway-progress.svg\n :target: https://pypi.python.org/pypi/learner-pathway-progress/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/edx/learner-pathway-progress.svg\n :target: https://github.com/edx/learner-pathway-progress/blob/master/LICENSE.txt\n :alt: License\n\n\nChange Log\n----------\n\n..\n All enhancements and patches to learner_pathway_progress will be documented\n in this file. It adheres to the structure of https://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n\n This project adheres to Semantic Versioning (https://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n~~~~~~~~~~\n\n[1.3.4]- 2023-06-16\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added management command to update existing LearnerPathwayProgress table.\n\n[1.3.3]- 2022-10-07\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added a data migration to delete data for LearnerEnterprisePathwayMembership and LearnerPathwayProgress table.\n\n[1.3.2]- 2022-09-07\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added enterprise with learner pathway membership.\n\n[1.3.1]- 2022-09-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Removed default attribute from `LearnerPathwayProgress.learner_pathway_uuid` field. This field must be provided at the time of instance creation.\n\n[1.3.0]- 2022-08-11\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added endpoint for LearnerPathwayProgress model.\n\n[1.2.3]- 2022-07-14\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Update the pathway progress type.\n\n[1.2.2]- 2022-07-05\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Added waffle flag on the top of signals code.\n\n[1.2.1]- 2022-06-20\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Update signal to accept CourseLocator as course_key.\n\n[1.2.0]- 2022-06-10\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n* Add management command and signal to update learner pathway progress and membership.\n\n[1.1.0] - 2022-06-02\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAdded\n_____\n\n* entry point for app\n* app_label in model\n\nChanged\n_______\n\n* Plugin app configuration\n\n\n[1.0.1] - 2022-06-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nFixed\n_____\n\n* Version in __init__.py\n\nChanged\n_______\n\n* name of package in setup.py file\n\n\n[1.0.0] - 2022-06-01\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAdded\n_____\n\n* Basic skeleton of the app.\n* LearnerPathwayMembership model.\n\nChanged\n_______\n\n* main branch from `main` to `master`\n\n\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "A plugin to track learners progress in pathways.",
"version": "1.3.4",
"project_urls": {
"Homepage": "https://github.com/edx/learner-pathway-progress"
},
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e00ac7b3b827dfa9804a3733584d3ced40a2d7e3519e5133efed5b60744fede",
"md5": "cd9e0012fea3dd6838586f54a5f894f0",
"sha256": "1085cdc17f6ac3bc55da116057b786fe49ae058472abfb961b4538f2f5ee35e3"
},
"downloads": -1,
"filename": "learner_pathway_progress-1.3.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd9e0012fea3dd6838586f54a5f894f0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 37586,
"upload_time": "2023-06-19T09:17:06",
"upload_time_iso_8601": "2023-06-19T09:17:06.983513Z",
"url": "https://files.pythonhosted.org/packages/4e/00/ac7b3b827dfa9804a3733584d3ced40a2d7e3519e5133efed5b60744fede/learner_pathway_progress-1.3.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1988b19ed8e35cff303e07d6bf18ff0765b67884fe5c8762dc32af9bc6f8e482",
"md5": "d88000c7574ccda3c36c3d1618b664b6",
"sha256": "c2919c57abe32e8210ee3b131c12c9f29c56c4e76311cf629b189446dfffa161"
},
"downloads": -1,
"filename": "learner-pathway-progress-1.3.4.tar.gz",
"has_sig": false,
"md5_digest": "d88000c7574ccda3c36c3d1618b664b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 33216,
"upload_time": "2023-06-19T09:17:08",
"upload_time_iso_8601": "2023-06-19T09:17:08.257187Z",
"url": "https://files.pythonhosted.org/packages/19/88/b19ed8e35cff303e07d6bf18ff0765b67884fe5c8762dc32af9bc6f8e482/learner-pathway-progress-1.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 09:17:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edx",
"github_project": "learner-pathway-progress",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "learner-pathway-progress"
}
JSON
