event-routing-backends

event-routing-backends

|pypi-badge| |travis-badge| |codecov-badge| |doc-badge| |pyversions-badge| |license-badge|

The README.rst file should start with a brief description of the repository, which sets it in the context of other repositories under the edx organization. It should make clear where this fits in to the overall edX codebase.

Various backends for receiving edX LMS events.

Overview (please modify)

The README.rst file should then provide an overview of the code in this repository, including the main components and useful entry points for starting to understand the code in more detail.

Documentation

(TODO: Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>_)

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

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

.. |travis-badge| image:: https://travis-ci.org/edx/event-routing-backends.svg?branch=master :target: https://travis-ci.org/edx/event-routing-backends :alt: Travis

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

*

[0.1.0] - 2020-09-22

Added

---

• First release on PyPI.