Skip to main content

ol-openedx-feedback

An Open edX plugin that adds a per-block “Send feedback” trigger to applicable leaf blocks in the LMS via an XBlockAside. The trigger is shown only to authenticated learners (never in Studio author/preview mode and never to anonymous users).

When a learner clicks the trigger the aside posts an ol-feedback::drawer-open message to its parent window (the Learning MFE) using window.parent.postMessage. The message payload carries the block context needed to identify the content being rated:

  • courseId — the course key

  • blockUsageKey — the block’s usage key

  • blockType — the XBlock category (e.g. problem, video)

  • blockDisplayName — the block’s display name

The Learning MFE receives the message and opens the feedback drawer, which submits the learner’s feedback directly to the mit-learn service. This plugin does not persist anything in edx-platform and exposes no REST API.

Installation

Install the package into the LMS Python environment:

pip install ol-openedx-feedback

The plugin registers itself automatically through its entry points — the xblock_asides.v1 aside plus the lms.djangoapp app config — so no changes to INSTALLED_APPS are required. Restart the LMS after installing. (The trigger is learner-facing only, so the plugin is LMS-only and is not installed in Studio/CMS.)

Enable XBlock asides in the LMS admin

XBlock asides must be turned on for any aside (including this one) to render. In the LMS Django admin, open XBlock Asides Config (/admin/lms_xblock/xblockasidesconfig/), add a new entry, and check Enabled. Make sure the block types you want the feedback trigger on are not listed in Disabled blocks (the space-separated field defaults to about course_info static_tab).

Enablement

Feedback is gated by the ol_openedx_feedback.feedback_enabled course waffle flag (default off). Enable it for the desired courses (or globally) to roll out.

Configuration

Excluded block types

By default the trigger renders on every leaf block and is suppressed only on structural containers (course / chapter / sequential / vertical). To additionally exclude one or more block types (for example html), override the excluded set through ENV_TOKENS (e.g. in lms.yml):

OL_OPENEDX_FEEDBACK_EXCLUDED_BLOCK_TYPES:
  - course
  - chapter
  - sequential
  - vertical
  - html

The plugin reads this value via its settings.common plugin_settings hook and exposes it as the OL_OPENEDX_FEEDBACK_EXCLUDED_BLOCK_TYPES Django setting, defaulting to the structural set above when unset.

Text label

The trigger shows only the megaphone icon by default. To also render the “Feedback” text label beside it, enable it through ENV_TOKENS:

OL_OPENEDX_FEEDBACK_SHOW_LABEL: true

This is exposed as the OL_OPENEDX_FEEDBACK_SHOW_LABEL Django setting via the same plugin_settings hook, defaulting to false (icon-only) when unset.

Metadata

Release files for ol-openedx-feedback 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ol-openedx-feedback 0.2.1
File Size Uploaded Provenance Actions
ol_openedx_feedback-0.2.1.tar.gz 7.9 kB Without provenance Details for ol_openedx_feedback-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ol-openedx-feedback 0.2.1
File Interpreter ABI Platform Actions
ol_openedx_feedback-0.2.1-py3-none-any.whl Python 3 none any Details for ol_openedx_feedback-0.2.1-py3-none-any.whl

Total release size: 19.3 kB

Release files / ol_openedx_feedback-0.2.1.tar.gz

Download URL ol_openedx_feedback-0.2.1.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
c53c8819a06cdb94a82bd7f322638c125b1445304e5fb960a2c3e602c196a45c
BLAKE2b-256 checksum
How to use checksums
db727611ff46b2b8e2e676d845245f5b0ae2a7ef4452f48b6c4ec5cb17721b54
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / ol_openedx_feedback-0.2.1-py3-none-any.whl

Download URL ol_openedx_feedback-0.2.1-py3-none-any.whl
Size 11.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
35703a55ad0d3948e29e8d1d2594a234f505ae4a6d88cbcb139d5e63a0399887
BLAKE2b-256 checksum
How to use checksums
4409117e6cee4323544dfb27776661adf2e854cfcaff03a53d3698968309ad46
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Security for ol-openedx-feedback 0.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page