Open edX events from the Hooks Extensions Framework
Open edX Events ###############
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge| |license-badge| |status-badge|
Open edX Events from Hooks Extensions Framework (OEP-50
_).
.. _OEP-50: https://open-edx-proposals.readthedocs.io/en/latest/oep-0050-hooks-extension-framework.html
Purpose
This repository implements the necessary tooling and definitions used by the Hooks Extension Framework to manage the events execution and extra tools.
Getting Started with Development
Please see the Open edX documentation for guidance on Python development <https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html>
_ in this repo.
Deploying
The Open edX Events component is a Python library which doesn't need independent deployment. Therefore, its setup is reasonably straightforward. First, it needs to be added to your service requirements, and then it will be installed alongside requirements of the service.
If the service you intend to use is either the LMS or CMS, then the library is installed alongside their requirements since the Maple release.
Getting Help
See documentation on Read the Docs <https://openedx-events.readthedocs.io/en/latest/>
_.
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 anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.
https://github.com/openedx/openedx-events/issues
For more information about these options, see the Getting Help
_ page.
.. _Slack invitation: https://openedx.org/slack .. _community Slack workspace: https://openedx.slack.com/ .. _Getting Help: https://openedx.org/getting-help
License
The code in this repository is licensed under the Apache 2.0 license unless otherwise noted.
Please see LICENSE.txt <LICENSE.txt>
_ for details.
Contributing
Contributions are very welcome.
Please read How To Contribute <https://openedx.org/r/how-to-contribute>
_ for details.
This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.
The Open edX Code of Conduct
All community members are expected to follow the Open edX Code of Conduct
_.
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
People
The assigned maintainers for this component and other project details may be
found in Backstage
_. Backstage pulls this data from the catalog-info.yaml
file in this repo.
.. _Backstage: https://backstage.openedx.org/catalog/default/component/openedx-events
Reporting Security Issues
Please do not report security issues in public. Please email security@openedx.org.
.. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-events.svg :target: https://pypi.python.org/pypi/openedx-events/ :alt: PyPI
.. |ci-badge| image:: https://github.com/openedx/openedx-events/workflows/Python%20CI/badge.svg?branch=main :target: https://github.com/openedx/openedx-events/actions :alt: CI
.. |codecov-badge| image:: https://codecov.io/github/openedx/openedx-events/coverage.svg?branch=main :target: https://codecov.io/github/openedx/openedx-events?branch=main :alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/openedx-events/badge/?version=latest :target: https://openedx-events.readthedocs.io/en/latest/ :alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-events.svg :target: https://pypi.python.org/pypi/openedx-events/ :alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/openedx/openedx-events.svg :target: https://github.com/openedx/openedx-events/blob/main/LICENSE.txt :alt: License
.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
.. All enhancements and patches to openedx_events 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.
Added
* Added new COURSE_NOTIFICATION_REQUESTED event in learning
[9.1.0] - 2023-11-07
--------------------
Added
Changed
* Fixed key error in merging event producer configs. Previously, setting only one of `enabled` or `event_key_field` would result in a KeyError being thrown
[9.0.0] - 2023-10-04
--------------------
Changed
Added
* Added new ``FORUM_THREAD_CREATED``, ``FORUM_THREAD_RESPONSE_CREATED``, ``FORUM_RESPONSE_COMMENT_CREATED`` events in learning subdomain
[8.8.0] - 2023-10-02
--------------------
Added
MANAGE_STUDENTS_PERMISSION_ADDED
and MANAGE_STUDENTS_PERMISSION_REMOVED
events in learningAdded
* Added new ``EXAM_ATTEMPT_SUBMITTED``, ``EXAM_ATTEMPT_REJECTED``, ``EXAM_ATTEMPT_VERIFIED``, ``EXAM_ATTEMPT_RESET``, and ``EXAM_ATTEMPT_ERRORED`` events in learning.
[8.6.0] - 2023-08-28
--------------------
Added
Changed
* Added json de/serialization for EventsMetadata
[8.4.0] - 2023-07-20
--------------------
Added
~~~~~
* Added new ``PROGRAM_CERTIFICATE_AWARDED`` and ``PROGRAM_CERTIFICATE_REVOKED`` events in learning subdomain
* Added new ``ProgramCertificateData`` and ``ProgramData`` data classes supporting the new program certificate events
[8.3.0] - 2023-07-10
--------------------
Added
~~~~~
* Added new XBLOCK_CREATED and XBLOCK_UPDATED events in content_authoring.
* Added new COURSE_CREATED event in content_authoring.
* Added new CONTENT_LIBRARY_CREATED, CONTENT_LIBRARY_UPDATED and CONTENT_LIBRARY_DELETED events in content_authoring.
* Added new LIBRARY_BLOCK_CREATED, LIBRARY_BLOCK_UPDATED and LIBRARY_BLOCK_DELETED events in content_authoring.
[8.2.0] - 2023-06-08
--------------------
Changed
Added
* Store current versions of Avro schemas and add test to ensure valid evolution
[8.0.1] - 2023-05-16
--------------------
Changed
Changed
* **Breaking change**: Remove ``signal`` argument from consume_events and make_single_consumer
[7.3.0] - 2023-05-15
--------------------
Changed
signal
argument optional in consume_events in preparation for removalChanged
* Added event type as namespace to generated Avro schemas
[7.1.0] - 2023-05-03
--------------------
Added
~~~~~
* Configurable loader for consumer side of Event Bus in ``openedx_events.event_bus``.
* Added management command to load configured consumer and start worker.
Changed
edx-sphinx-theme
to sphinx-book-theme
since the former is
deprecated. See https://github.com/openedx/edx-sphinx-theme/issues/184 for
more details.Changed
* **Breaking change**: Moved serialize_event_data_to_bytes from openedx_events.event_bus.avro.tests.test_utilities to openedx_events.event_bus.avro.serializer
* **Breaking change**: Moved deserialize_bytes_to_event_data from openedx_events.event_bus.avro.tests.test_utilities to openedx_events.event_bus.avro.deserializer
[6.0.0] - 2023-02-23
---------------------
Changed
Added
* Added support for array type.
* Added new XBLOCK_SKILL_VERIFIED event.
* Added XBlockSkillVerificationData classes.
[5.0.0] - 2023-02-03
--------------------
Changed
send_event_with_custom_metadata
changes to accept a single EventsMetadata object rather than all of the fields that go into one. This only directly affects event bus consumer libraries.Added
* Added ``COURSE_CERTIFICATE_CONFIG_CHANGED`` and ``COURSE_CERTIFICATE_CONFIG_DELETED`` signals for when a course's certificate configuration is updated or deleted
[4.2.0] - 2023-01-24
--------------------
Added
send_event_with_custom_metadata
. This will enable event bus consumers to send the event signal with the same metadata fields that were used when the event was produced.Fixed
* Updated time metadata to include UTC timezone. The original implementation used utcnow(), which could give different results if the time were ever interpreted to be local time. See https://docs.python.org/3/library/datetime.html#datetime.datetime.utcnow
* EventsMetadata minorversion is now fully optional, and doesn't need to be supplied when initializing to get the default of 0.
Changed
Changed
* Use collections.abc import to use with python 3.8 and 3.10.
[4.1.0] - 2023-01-03
---------------------
Added
~~~~~
* Added new XBLOCK_PUBLISHED, XBLOCK_DUPLICATED and XBLOCK_DELETED signals in content_authoring.
* Added XBlockData and DuplicatedXBlockData classes
* Added custom UsageKeyAvroSerializer for opaque_keys UsageKey.
[4.0.0] - 2022-12-01
--------------------
Changed
Changed
* Add event_metadata parameter to EventBusProducer send API. **Note:** Calling this method with the new argument will throw an exception with older versions of this library that don't yet support the parameter.
[3.1.0] - 2022-11-22
--------------------
Added
~~~~~
* Configurable loader for producer side of Event Bus in ``openedx_events.event_bus``.
[3.0.1] - 2022-10-31
--------------------
Fixed
~~~~~
* Fix default value for optional fields from "null" to None
[3.0.0] - 2022-10-19
--------------------
* **Breaking change**: Removed (optional) field ``effort`` from ``CourseCatalogData.`` Nothing should be relying on this field as it is not used by Course Discovery in Publisher-enabled setups.
[2.0.0] - 2022-10-18
--------------------
* **Breaking change**: Removed signal ``SUBSCRIPTION_LICENSE_MODIFIED`` and corresponding data class ``SubscriptionLicenseData``. This should only affect experimental event-bus code (which should also have been deleted by now).
[1.0.0] - 2022-09-27
--------------------
* **Breaking Change**: Updated from ``Django 2.0`` to ``Django 3.0``.
* Bump version to 1.x to acknowledge that this is in use in production
[0.14.0] - 2022-09-21
---------------------
Changed
short_description
from CourseCatalogData
Added
* Added new event PERSISTENT_GRADE_SUMMARY_CHANGED.
* Improvements in make upgrade command and requirements files.
* Manually update requirements files to fix requirements bot issue with pip/setup tools.
* Change GitHub workflow to community maintained repository health file.
[0.12.0] - 2022-08-16
---------------------
Changed
org
and number
fields from CourseCatalogData
(should only affect unreleased event-bus code, though)Fixed
* Handle optional (None) values for custom serializers
[0.11.0] - 2022-07-21
---------------------
Added
Changed
* BREAKING CHANGE: Split AvroAttrsBridge into schema, serialization, and deserialization phases
[0.9.1] - 2022-05-20
--------------------
Changed
Changed
* Updated AvroAttrsBridge to handle optional/nullable fields
[0.8.3] - 2022-04-26
--------------------
Changed
Changed
* Changed openedx_events.learning.data.DiscussionTopicContext to make the group id optional
* Changed DiscussionTopicContext to add a `context` attribute
[0.8.1] - 2022-03-03
--------------------
Added
~~~~~
* Added missing field for event COURSE_DISCUSSIONS_CHANGED
[0.8.0] - 2022-02-25
--------------------
Added
~~~~~
* Added COURSE_DISCUSSIONS_CHANGED for discussion event
Changed
Added
* Added data definition for enterprise/LicenseLifecycle
* Added LicenseCreated signal definition
[0.7.0] - 2022-01-06
--------------------
Added
Added
* Add custom formatting class for events responses.
* Add a way to use send method instead of send_robust while testing.
Changed
Changed
* Remove TestCase inheritance from OpenEdxTestMixin.
[0.5.0] - 2021-08-24
--------------------
Added
~~~~~
* Utilities to use while testing in other platforms.
[0.4.1] - 2021-08-18
--------------------
Changed
Added
* Preliminary Open edX events definitions.
[0.3.0] - 2021-08-18
--------------------
Added
Changed
* Update repository purpose.
* Changed max-doc-length from 79 to 120 following community recommendation.
[0.1.3] - 2021-07-01
--------------------
Changed
Changed
* Update documentation with current organization info.
[0.1.1] - 2021-06-29
--------------------
Added
~~~~~
* Add Django testing configuration.
[0.1.0] - 2021-04-07
--------------------
Added
~~~~~
* First release on PyPI.