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.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ol_openedx_feedback-0.2.2.tar.gz | 8.1 kB | Without provenance | Details for ol_openedx_feedback-0.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ol_openedx_feedback-0.2.2-py3-none-any.whl | Python 3 | none | any | Details for ol_openedx_feedback-0.2.2-py3-none-any.whl |
Total release size: 19.6 kB
Release files / ol_openedx_feedback-0.2.2.tar.gz
| Download URL | ol_openedx_feedback-0.2.2.tar.gz |
|---|---|
| Size | 8.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8aa44cc2c22611389b153feb85dc12621e8d4073b39a549cb02081110bf68cb2
|
|
BLAKE2b-256 checksum How to use checksums |
5a44771b27c7fc8171c3b3773c962cb9632769b97feea5665010ae8cba0a917e
|
| 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.2-py3-none-any.whl
| Download URL | ol_openedx_feedback-0.2.2-py3-none-any.whl |
|---|---|
| Size | 11.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
035528dfd2c3fec9bd823c74bf60840d1b8d8bc4da93546a2a86b219cc10691d
|
|
BLAKE2b-256 checksum How to use checksums |
abdb6dce98c01d13d1211629dc11e1c2043c59f696a9d18bf2f1ed844108dc16
|
| 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.2
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.