edx-milestones [](https://github.com/openedx/edx-milestones/actions?query=workflow%3A%22Python+CI%22) [](https://coveralls.io/r/edx/edx-milestones?branch=master)
===================
edx-milestones (`milestones`) is a Django application which manages significant Course and/or Student events in the Open edX platform.
Usage
-----
* A Milestone represents an event which can occur for a student while interacting with the Open edX platform.
* Relationships can be created between courses or individual sections of course content (referred to collectively as course entities going forward) and a Milestone. A relationship can indicate that a course entity either requires or fulfills a given Milestone.
* Student milestone fulfillment status can be recorded and queried.
* An example feature which Milestones supports is Pre-requisite Courses:
* Course author selects Course 101 in Studio as a pre-requisite of Course 102
* Studio:
* Makes call to Milestones service API
* Milestones:
* Creates a new generic Milestone A for Course 101
* Indicates that Course 101 fulfills Milestone A
* Indicates that Course 102 requires Milestone A
* Student Smith completes Course 101
* LMS:
* Makes call to Milestones service API
* Milestones:
* Pulls the list of milestones fulfilled by Course 101 (set includes Milestone A)
* Indicates that Student Smith has accomplished Milestone A
* Student Smith attempts to access Course 102
* LMS:
* Uses Milestones service API to compare Course 102 milestone requirements against Student Smith's milestones
* Grants Student Smith access to Course 102
Standalone Testing and Quality Check
------------------------------------
$ make quality
$ make test
Open edX Platform Integration
-----------------------------
* This package is included in the [base](https://github.com/openedx/edx-platform/blob/master/requirements/edx/base.in#L85) requirements of [edx-platform](https://github.com/openedx/edx-platform/)
* `milestones` is included in the list of installed apps for edx-platform:
* These documents outline the feature flags required to enable the features that use edx-milestones.
* [Course Run prerequisites](https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/enable_prerequisites.html#enable-course-prerequisites)
* [Subsection prerequisites](https://edx-partner-course-staff.readthedocs.io/en/latest/developing_course/controlling_content_visibility.html#prerequisite-course-subsections)
How to Contribute
-----------------
Contributions are very welcome please see our
[CONTRIBUTING](https://github.com/openedx/.github/blob/master/CONTRIBUTING.md)
file for more information -- it also contains guidelines for how to maintain
high code quality, which will make your contribution more likely to be accepted.
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](https://openedx.org/slack), then join our [community Slack team](http://openedx.slack.com/).
For more information about these options, see the [Getting Help](https://openedx.org/getting-help) page.
Reporting Security Issues
-------------------------
Please do not report security issues in public. Please email security@edx.org.
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/edx-milestones",
"name": "edx-milestones",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "edX",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/74/b4/3066f953505a8e4cf82b605eebcf2bc176c1db9c6e51ccaab91f249c4e1b/edx-milestones-0.5.0.tar.gz",
"platform": null,
"description": "edx-milestones [](https://github.com/openedx/edx-milestones/actions?query=workflow%3A%22Python+CI%22) [](https://coveralls.io/r/edx/edx-milestones?branch=master)\n===================\n\nedx-milestones (`milestones`) is a Django application which manages significant Course and/or Student events in the Open edX platform.\n\nUsage\n-----\n* A Milestone represents an event which can occur for a student while interacting with the Open edX platform.\n\n* Relationships can be created between courses or individual sections of course content (referred to collectively as course entities going forward) and a Milestone. A relationship can indicate that a course entity either requires or fulfills a given Milestone.\n\n* Student milestone fulfillment status can be recorded and queried.\n\n* An example feature which Milestones supports is Pre-requisite Courses:\n * Course author selects Course 101 in Studio as a pre-requisite of Course 102\n * Studio:\n * Makes call to Milestones service API\n * Milestones:\n * Creates a new generic Milestone A for Course 101\n * Indicates that Course 101 fulfills Milestone A\n * Indicates that Course 102 requires Milestone A\n * Student Smith completes Course 101\n * LMS:\n * Makes call to Milestones service API\n * Milestones:\n * Pulls the list of milestones fulfilled by Course 101 (set includes Milestone A)\n * Indicates that Student Smith has accomplished Milestone A\n * Student Smith attempts to access Course 102\n * LMS:\n * Uses Milestones service API to compare Course 102 milestone requirements against Student Smith's milestones\n * Grants Student Smith access to Course 102\n\nStandalone Testing and Quality Check\n------------------------------------\n\n $ make quality\n $ make test\n\nOpen edX Platform Integration\n-----------------------------\n* This package is included in the [base](https://github.com/openedx/edx-platform/blob/master/requirements/edx/base.in#L85) requirements of [edx-platform](https://github.com/openedx/edx-platform/)\n* `milestones` is included in the list of installed apps for edx-platform:\n* These documents outline the feature flags required to enable the features that use edx-milestones.\n * [Course Run prerequisites](https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/enable_prerequisites.html#enable-course-prerequisites)\n * [Subsection prerequisites](https://edx-partner-course-staff.readthedocs.io/en/latest/developing_course/controlling_content_visibility.html#prerequisite-course-subsections)\n\n\nHow to Contribute\n-----------------\nContributions are very welcome please see our\n[CONTRIBUTING](https://github.com/openedx/.github/blob/master/CONTRIBUTING.md)\nfile for more information -- it also contains guidelines for how to maintain\nhigh code quality, which will make your contribution more likely to be accepted.\n\nGetting Help\n------------\nIf you're having trouble, we have discussion forums at\nhttps://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\ninvitation](https://openedx.org/slack), then join our [community Slack team](http://openedx.slack.com/).\n\nFor more information about these options, see the [Getting Help](https://openedx.org/getting-help) page.\n\nReporting Security Issues\n-------------------------\nPlease do not report security issues in public. Please email security@edx.org.\n",
"bugtrack_url": null,
"license": "AGPL",
"summary": "Significant events module for Open edX",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/openedx/edx-milestones"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "77e17752bb4df1d1762ad1c4a79dcd4f5eeecf6d42c059c65addc2b1f4ee5a5c",
"md5": "5df63af412ce97fa931e219ccbf6f697",
"sha256": "02e2f3af0eac90503a6c98102f38a2e98c4f28647b73f174ec1f8acb9cebd741"
},
"downloads": -1,
"filename": "edx_milestones-0.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5df63af412ce97fa931e219ccbf6f697",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 39437,
"upload_time": "2023-07-24T08:42:29",
"upload_time_iso_8601": "2023-07-24T08:42:29.940628Z",
"url": "https://files.pythonhosted.org/packages/77/e1/7752bb4df1d1762ad1c4a79dcd4f5eeecf6d42c059c65addc2b1f4ee5a5c/edx_milestones-0.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74b43066f953505a8e4cf82b605eebcf2bc176c1db9c6e51ccaab91f249c4e1b",
"md5": "324ba320e6876d30ee4b66075ccf5da4",
"sha256": "6b9fe9916043c880ccd9178ea00e2d199e4339b30b3adfc0ab6544b9db9c85bd"
},
"downloads": -1,
"filename": "edx-milestones-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "324ba320e6876d30ee4b66075ccf5da4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33583,
"upload_time": "2023-07-24T08:42:30",
"upload_time_iso_8601": "2023-07-24T08:42:30.881784Z",
"url": "https://files.pythonhosted.org/packages/74/b4/3066f953505a8e4cf82b605eebcf2bc176c1db9c6e51ccaab91f249c4e1b/edx-milestones-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-24 08:42:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "edx-milestones",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "edx-milestones"
}
JSON
