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
Enable XBlock in Studio
`Settings -> Advanced Settings -> Advanced Module List` add `openedx_cmi5_xblock`
Use it in any of the units by adding `CMI5 Module` from Advanced blocks list
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
.. code-block::
XBLOCK_SETTINGS["CMI5XBlock"] = {
"LRS_AUTH_KEY": "<LRS-activity-provider-key>",
"LRS_AUTH_SECRET": "<LRS-secret-key>",
"LRS_ENDPOINT": "<domain>/lrs/<LRS-app-id>/statements/"
# ... other settings
}
Change Log
##########
..
All enhancements and patches to openedx_cmi5_xblock 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
**********
*
0.1.0 – 2023-07-06
**********************************************
Added
=====
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/edly-io/openedx-cmi5-xblock",
"name": "openedx-cmi5-xblock",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Python edx cmi5 xblock",
"author": "edly",
"author_email": "hello@edly.io",
"download_url": "https://files.pythonhosted.org/packages/38/5a/1c3d5f44c96a357ce6fee362138b6862fb96e2425a2fc2246cae8191b678/openedx-cmi5-xblock-0.1.0.tar.gz",
"platform": null,
"description": "Openedx CMI5 XBlock\n#############################\n\nXblock to integrate CMI5 content in Open edX. It provides following features\n\n* Ability to upload CMI5 package or cmi5.xml file\n* Parses xAPI statements generated by CMI5 content to set grade and track progress of learner\n* Ability to push xAPI statements to a configured LRS \n\nSetup\n********************\n\nInstall CMI5 XBlock\n\n $ pip install openedx-cmi5-xblock\n\nEnable XBlock in Studio\n\n `Settings -> Advanced Settings -> Advanced Module List` add `openedx_cmi5_xblock` \n\nUse it in any of the units by adding `CMI5 Module` from Advanced blocks list\n\nAdvanced configuration for sending data to LRS\n**********************************************\n\nCMI5 Xblock can be configured to push xAPI statements to a Third-party Learning Record Store. To configure that, use these settings\n\n.. code-block::\n\n XBLOCK_SETTINGS[\"CMI5XBlock\"] = {\n \"LRS_AUTH_KEY\": \"<LRS-activity-provider-key>\",\n \"LRS_AUTH_SECRET\": \"<LRS-secret-key>\",\n \"LRS_ENDPOINT\": \"<domain>/lrs/<LRS-app-id>/statements/\"\n # ... other settings\n }\n\n\n\nChange Log\n##########\n\n..\n All enhancements and patches to openedx_cmi5_xblock 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*\n\n0.1.0 \u2013 2023-07-06\n**********************************************\n\nAdded\n=====\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Openedx CMI5 XBlock",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/edly-io/openedx-cmi5-xblock"
},
"split_keywords": [
"python",
"edx",
"cmi5",
"xblock"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fdab8a73ad3dbdb0e0943bae8995acb4a7e647fb7105a3d2f9dcb24d07d4898a",
"md5": "7601f3eaeb2ba5a36241993ecd8c85a1",
"sha256": "abe6b9b7e921a3aa78a94e63308c78be939f5cb4948b8fa0b0f1b856ad1c9e2e"
},
"downloads": -1,
"filename": "openedx_cmi5_xblock-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7601f3eaeb2ba5a36241993ecd8c85a1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 17961,
"upload_time": "2024-03-29T06:37:00",
"upload_time_iso_8601": "2024-03-29T06:37:00.352607Z",
"url": "https://files.pythonhosted.org/packages/fd/ab/8a73ad3dbdb0e0943bae8995acb4a7e647fb7105a3d2f9dcb24d07d4898a/openedx_cmi5_xblock-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "385a1c3d5f44c96a357ce6fee362138b6862fb96e2425a2fc2246cae8191b678",
"md5": "453ef2c0e59f5ce6453c06ccea9d7fae",
"sha256": "db5ac6ed5808b9cb0930f1b192e392a1ae4b9f3894d60f2330d3be291d83f4a0"
},
"downloads": -1,
"filename": "openedx-cmi5-xblock-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "453ef2c0e59f5ce6453c06ccea9d7fae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17911,
"upload_time": "2024-03-29T06:37:02",
"upload_time_iso_8601": "2024-03-29T06:37:02.724259Z",
"url": "https://files.pythonhosted.org/packages/38/5a/1c3d5f44c96a357ce6fee362138b6862fb96e2425a2fc2246cae8191b678/openedx-cmi5-xblock-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 06:37:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edly-io",
"github_project": "openedx-cmi5-xblock",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "openedx-cmi5-xblock"
}
JSON
