edx-event-routing-backends 5.0.0

Various backends for receiving edX LMS events.

Various backends for retransmitting edX LMS events to external services.

Overview

event-routing-backends contains plugins for the event-tracking app that is installed as a part of edx-platform. It provides a backend that can take events and re-transmit them to external services. It also provides some new processers that can convert edx-platform events into other formats.

Currently work to support xAPI and Caliper event formats is in progress.

See OEP 26 for background; the xAPI and Caliper subdocuments in particular include a specification of how LMS events will be translated to the format of the respective protocols.

Documentation

Documentation for this repo is published to Read the Docs

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome. Please read How To Contribute for details. Even though they were written with edx-platform in mind, the guidelines should be followed for all Open edX projects.

The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you can find it at PULL_REQUEST_TEMPLATE.md.

The issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you can find it at ISSUE_TEMPLATE.md.

Reporting Security Issues

Please do not report security issues in public. Please email [e-mail].

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 workspace.

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

Change Log

Unreleased

[4.1.1]

• Switched from jsonfield2 to jsonfield as the earlier one has archived and merged back in the latter one.

[4.1.0]

• Added support for django3.0, 3.1 and 3.2

[4.0.1]

• Change a noisy INFO log message in TransformerRegistry.register() to DEBUG and fix two logging typos.

[4.0.0]

• Breaking change: Rename CaliperEnvelopProcessor to CaliperEnvelopeProcessor and rename module accordingly (typo fix)

[3.0.2]

• Added more directions for local testing

• changed how event data is enveloped for caliper events

• changed url to point from http://purl.imsglobal.org/ctx/caliper/v1p1 to http://purl.imsglobal.org/ctx/caliper/v1p2

[3.0.1]

This tag is a re-release of version 3.0.0. (Failed to bump internal version, though.)

[3.0.0]

• Breaking change: Caliper and xAPI processors will reject events unless the CALIPER_EVENTS_ENABLED and XAPI_EVENTS_ENABLED Django settings are enabled, respectively.

[2.0.0]

(no changelog recorded)

[1.0.0] - 2020-11-09

Removed

• Dropped support for Python 3.5

[0.2.0] - 2020-11-06

Added

• caliper transformer backend

• event routing backend

[0.1.0] - 2020-09-22

Added

• First release on PyPI.