openedx-events

What it is and what it does

Open edX Events is a Python library that implements the Hooks Extension Framework (OEP-50) for Open edX, providing standardized event definitions and tooling to enable event-driven communication between Open edX services. It defines events across multiple domains (learning, authoring, enterprise, content authoring) and handles event serialization using Avro, allowing services to emit and consume events through a shared event bus.

The library is not independently deployed but installed as a dependency within Open edX services (LMS, CMS, and custom extensions). It depends on Django, attrs, edx-opaque-keys, edx-ccx-keys, edx_django_utils, fastavro, and setuptools. Recent versions (11.2.0) add new event types like ROLE_ASSIGNMENT_CREATED and ROLE_ASSIGNMENT_DELETED, and improve support for complex nested types in event data structures.

Use it for:

• Emit course enrollment, completion, or discussion events from Open edX LMS to downstream systems or event consumers.
• Define and consume custom events in Open edX extensions using the standardized Hooks Extension Framework.
• Serialize and deserialize event payloads using Avro for reliable event bus communication between services.
• Track role assignments, course reruns, library publications, and other authoring domain events.
• Integrate third-party systems with Open edX by listening to standardized event signals.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides event definitions and tooling for the Open edX Hooks Extension Framework (OEP-50), enabling event-driven architecture within Open edX services.

Yes, if you are developing within or extending Open edX. This is the canonical event framework for Open edX services and is required for event-driven integrations. Install friction is low and maintenance is active. No security vulnerabilities are known. Not suitable for non-Open edX projects.

Install

openedx-events on PyPI

pip install openedx-events

uv add openedx-events

poetry add openedx-events

Installing openedx-events

Before you install

Low install friction with a pure-Python wheel. Actively maintained with recent releases; last commit 2026-08-10. Requires 7 runtime dependencies including Django, attrs, and edx-specific packages (edx-opaque-keys, edx-ccx-keys, edx_django_utils), which may already be present in Open edX deployments.

License in practice

Licensed under Apache 2.0 (permissive), allowing use in both open-source and proprietary projects with minimal restrictions.

Quickstart

pip install openedx-events

from openedx_events.learning.signals import COURSE_ENROLLMENT_CREATED
from openedx_events.data import CourseEnrollmentData

# Emit or listen to events via the Hooks Extension Framework

Requires Python 3.12 or later; designed for use within Open edX service deployments or extensions that have Django and edx-specific dependencies available.

Verify before relying

• Whether the package can be used standalone outside an Open edX deployment, or if it requires a full Open edX environment.
• Specific event types and signal names available beyond those mentioned in the changelog excerpt.
• Performance characteristics when handling high-volume event streams.

Package facts

Evidence: openedx_events-11.2.0-py3-none-any.whl

Keywords: Python, edx

Tags

More Application Frameworks packages