Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/openedx/event-routing-backends

Consume edx tracking events and transform/transmit them to other LRSs.
https://github.com/openedx/event-routing-backends

Last synced: 5 days ago
JSON representation

Consume edx tracking events and transform/transmit them to other LRSs.

Awesome Lists containing this project

README 

        
event-routing-backends

=============================



|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|

|license-badge|



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.



.. _event-tracking: https://github.com/openedx/event-tracking

.. _OEP 26: https://open-edx-proposals.readthedocs.io/en/latest/oep-0026-arch-realtime-events.html



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.

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 <.github/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 <.github/ISSUE_TEMPLATE.md>`_.



Reporting Security Issues

-------------------------



Please do not report security issues in public. Please email [email protected].



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.



.. _Slack invitation: https://openedx.org/slack

.. _community Slack workspace: https://openedx.slack.com/



.. |pypi-badge| image:: https://img.shields.io/pypi/v/event-routing-backends.svg

    :target: https://pypi.python.org/pypi/event-routing-backends/

    :alt: PyPI



.. |ci-badge| image:: https://github.com/openedx/event-routing-backends/workflows/Python%20CI/badge.svg?branch=master

    :target: https://github.com/openedx/event-routing-backends/actions?query=workflow%3A%22Python+CI%22

    :alt: CI



.. |codecov-badge| image:: https://codecov.io/github/edx/event-routing-backends/coverage.svg?branch=master

    :target: https://codecov.io/github/edx/event-routing-backends?branch=master

    :alt: Codecov



.. |doc-badge| image:: https://readthedocs.org/projects/event-routing-backends/badge/?version=latest

    :target: https://event-routing-backends.readthedocs.io/en/latest/

    :alt: Documentation



.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/event-routing-backends.svg

    :target: https://pypi.python.org/pypi/event-routing-backends/

    :alt: Supported Python versions



.. |license-badge| image:: https://img.shields.io/github/license/edx/event-routing-backends.svg

    :target: https://github.com/openedx/event-routing-backends/blob/master/LICENSE.txt

    :alt: License