Skip to main content

Significant events module for Open edX

Project description

edx-milestones Build Status Coverage Status

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

How to Contribute

Contributions are very welcome please see our CONTRIBUTING 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, then join our community Slack team.

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

Reporting Security Issues

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

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

edx_milestones-1.1.0.tar.gz (35.2 kB view details)

Uploaded Source

Built Distribution

edx_milestones-1.1.0-py2.py3-none-any.whl (39.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file edx_milestones-1.1.0.tar.gz.

File metadata

  • Download URL: edx_milestones-1.1.0.tar.gz
  • Upload date:
  • Size: 35.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for edx_milestones-1.1.0.tar.gz
Algorithm Hash digest
SHA256 220eaa01f43b7a5e525d422a35f3febac3cec0b7352d3f1034aeaacee674fd81
MD5 22cee61c8a9349e83d729f0c4ab4afc9
BLAKE2b-256 fa218e31680869f8a6e7dfa1a7c6df0531b3746471aa06a476e693d754a7fa7b

See more details on using hashes here.

File details

Details for the file edx_milestones-1.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for edx_milestones-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 14c059050ee3bf6b631e5386ef846053e19def4bff74924cbe52bb156316df21
MD5 e1021f7113e647fc8518d29bda30913e
BLAKE2b-256 c863c9016c23273cc2106649f7edb2f278fbd882bd1b0e84b025713e493acb28

See more details on using hashes here.

Supported by

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