Metadata-Version: 2.1
Name: openedx-cmi5-xblock
Version: 0.1.0
Summary: Openedx CMI5 XBlock
Home-page: https://github.com/edly-io/openedx-cmi5-xblock
Author: edly
Author-email: hello@edly.io
License: MIT
Keywords: Python edx cmi5 xblock
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
License-File: LICENSE
Requires-Dist: Mako
Requires-Dist: XBlock
Requires-Dist: django-statici18n
Requires-Dist: edx-i18n-tools
Requires-Dist: xblock-utils

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.
