Metadata-Version: 1.2
Name: edx-event-routing-backends
Version: 4.0.1
Summary: Various backends for receiving edX LMS events.
Home-page: https://github.com/edx/event-routing-backends
Author: edX
Author-email: oscm@edx.org
License: AGPL 3.0
Description: 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.
        
        .. _event-tracking: https://github.com/edx/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 <https://event-routing-backends.readthedocs.io/en/latest/>`_
        
        License
        -------
        
        The code in this repository is licensed under the AGPL 3.0 unless
        otherwise noted.
        
        Please see `LICENSE.txt <LICENSE.txt>`_ for details.
        
        How To Contribute
        -----------------
        
        Contributions are very welcome.
        Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ 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 <.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 security@edx.org.
        
        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-slack-invite.herokuapp.com/
        .. _community Slack workspace: https://openedx.slack.com/
        .. _Getting Help: https://openedx.org/getting-help
        
        .. |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/edx/event-routing-backends/workflows/Python%20CI/badge.svg?branch=master
            :target: https://github.com/edx/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/edx/event-routing-backends/blob/master/LICENSE.txt
            :alt: License
        
        
        Change Log
        ----------
        
        ..
           All enhancements and patches to event_routing_backends 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
        ~~~~~~~~~~
        
        *
        
        [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.
        
Keywords: Python edx
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
