tutor-contrib-sample
A Tutor plugin that installs and wires up the three other sub-packages in this repo (backend-plugin-sample, frontend-plugin-sample, and brand-sample) into a Tutor-based Open edX deployment. Enabling this plugin is the simplest way to see all three working together.
How to use it
See the root README for the full setup. The minimum:
pip install -e ./tutor-contrib-sample
tutor plugins enable sample
tutor dev launch
tutor-mfe is required for the frontend slot configuration to apply; the plugin degrades gracefully (backend + brand only) if it isn't installed.
How it works
The plugin is a single file: tutorsample/plugin.py. Each section below is independent of the others.
Backend. Installs the published openedx-plugin-sample package from PyPI into the LMS and CMS images via the openedx-dockerfile-post-python-requirements patch. Also registers backend-plugin-sample as a MOUNTED_DIRECTORIES entry, so that running tutor mounts add "$PWD/backend-plugin-sample" bind-mounts your local checkout and pip-installs that instead.
Migrations. Adds manage.py lms migrate openedx_plugin_sample (and the CMS equivalent) to the tutor … do init task list.
Frontend. (Only when tutor-mfe is installed.) Installs the published @openedx/plugin-sample npm package into every MFE image, injects an import { CourseList } from '@openedx/plugin-sample' into the generated env.config.jsx, and wires CourseList into the org.openedx.frontend.learner_dashboard.course_list.v1 slot (hiding the default contents).
Brand. Sets MFE_CONFIG["PARAGON_THEME_URLS"] to load Paragon's default light theme overlaid with the compiled brand-sample/dist/light.min.css served from jsDelivr.
TODO: the brand override currently assumes
brand-samplehas been pushed to jsDelivr frommain. For a source-hacking workflow, this should be swapped for the tutor-contrib-paragon flow described inbrand-sample/README.md.
1 maintainer
Metadata
1 maintainer
Release files for tutor-contrib-sample 3.8.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tutor_contrib_sample-3.8.4.tar.gz | 8.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tutor_contrib_sample-3.8.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.9 kB
Release files / tutor_contrib_sample-3.8.4.tar.gz
| Download URL | tutor_contrib_sample-3.8.4.tar.gz |
|---|---|
| Size | 8.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
76cd79a3cc959db3effe698910fef3ead239d5c6d58f5208b398fcf8d63baefd
|
|
BLAKE2b-256 checksum How to use checksums |
27665f4aaa5c63fe381c975389d0b62bf10b1cd9114735dbe35c87e670a9512d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logRelease files / tutor_contrib_sample-3.8.4-py3-none-any.whl
| Download URL | tutor_contrib_sample-3.8.4-py3-none-any.whl |
|---|---|
| Size | 8.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3b914b8001a7fe767b85db146d912f41905258a35009a45b7cb24a6eca9466f6
|
|
BLAKE2b-256 checksum How to use checksums |
e904b3f537fdb09af69ddbcd9a0870b7d0f780c4035e8c8538f64f1c57469374
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency log
