openedx-cmi5-xblock 0.1.3

Openedx CMI5 XBlock

Openedx CMI5 XBlock

Xblock to integrate CMI5 content in Open edX. It provides following features

• Ability to upload CMI5 package or cmi5.xml file

• Parses xAPI statements generated by CMI5 content to set grade and track progress of learner

• Ability to push xAPI statements to a configured LRS

Setup

Install CMI5 XBlock:

pip install openedx-cmi5-xblock

Update course advanced settings by adding openedx_cmi5_xblock as shown in below image:

Go back to your course content. In the “Add New Component” section, click “Advanced”, and then “CMI5 module”. Click “Edit” on the newly-created module: this is where you will upload your content package. It should be a .zip file or a .xml file containing the cmi5 content.

The cmi5 unit will display a link in the studio and the LMS. Clicking on the link will take users to a new tab where they can interact with the cmi5 content.

Advanced configuration for sending data to LRS

CMI5 Xblock can be configured to push xAPI statements to a Third-party Learning Record Store. To configure that, use these settings

XBLOCK_SETTINGS["CMI5XBlock"] = {
    "LRS_AUTH_KEY": "<LRS-activity-provider-key>",
    "LRS_AUTH_SECRET": "<LRS-secret-key>",
    "LRS_ENDPOINT": "<domain>/lrs/<LRS-app-id>/statements/"
}

These settings may be added using Tutor by creating a tutor plugin:

from tutor import hooks

hooks.Filters.ENV_PATCHES.add_item(
    (
        "openedx-common-settings",
        """
XBLOCK_SETTINGS["CMI5XBlock"] = {
    "LRS_AUTH_KEY": "<LRS-activity-provider-key>",
    "LRS_AUTH_SECRET": "<LRS-secret-key>",
    "LRS_ENDPOINT": "<domain>/lrs/<LRS-app-id>/statements/"
}"""
)
)

Change Log

Unreleased

0.1.0 – 2023-07-06

Added

• First release on PyPI.