backend-plugin-sample

A Django app plugin for edx-platform that adds a small course-archiving feature: learners can mark courses as archived (hidden from their active list) and unarchive them later. It demonstrates three backend extension points working together:

A model + REST API (CourseArchiveStatus), consumed by frontend-plugin-sample
An Open edX Events handler that auto-unarchives on verified upgrade
An Open edX Filters pipeline step that rewrites the course-about URL

How to use it

See the root README for setup instructions. With Tutor, tutor-contrib-sample installs this plugin automatically (or bind-mounts your local checkout if you tutor mounts add it). Without Tutor, pip install -e . into your edx-platform environment and run migrations.

How it works

Plugin registration. apps.py declares the Django app to edx-platform via the plugin_app config (URL routing, settings, signal registration). The entry points in pyproject.toml make the platform discover the app automatically — no INSTALLED_APPS edit needed. See How to create a plugin app.

Model. models.py defines CourseArchiveStatus(user, course_id, is_archived, archive_date), indexed for the lookups the API performs. Registered in Django admin via admin.py.

REST API. views.py exposes the model as a DRF ModelViewSet at /sample-plugin/api/v1/course-archive-status/, with per-user permissions, throttling, and pagination. Serializer in serializers.py; URLs in urls.py. Business logic (e.g. setting archive_date when is_archived becomes true) lives in perform_create/perform_update rather than in the serializer.

Event handler. signals.py listens for COURSE_ENROLLMENT_CHANGED and unarchives a learner's course when they upgrade to the verified track. An event (not a filter) is the right shape here because we want a one-time nudge at the moment of upgrade — if the learner re-archives the course later, we respect that. A filter would re-impose the rule on every render.

Filter. pipeline.py implements ChangeCourseAboutPageUrl, a PipelineStep for org.openedx.learning.course.about.render.started.v1 that rewrites course-about URLs to an external host. Registered via OPEN_EDX_FILTERS_CONFIG in settings/common.py.

Settings. Per-environment settings live in settings/ (common.py, production.py, test.py). The plugin app loads these via its plugin_app config in apps.py.

Testing and quality

cd backend-plugin-sample
make requirements   # install test deps
make test           # pytest
make quality        # lint

Tests live in tests/.

Development Status
- 3 - Alpha
Framework
Intended Audience
- Developers
Natural Language
- English
Programming Language
- Python :: 3
- Python :: 3.12

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openedx_plugin_sample-3.8.0.tar.gz (147.5 kB view details)

Uploaded Sep 1, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

openedx_plugin_sample-3.8.0-py3-none-any.whl (24.6 kB view details)

Uploaded Sep 1, 2026 Python 3

File details

Details for the file openedx_plugin_sample-3.8.0.tar.gz.

File metadata

Download URL: openedx_plugin_sample-3.8.0.tar.gz
Upload date: Sep 1, 2026
Size: 147.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for openedx_plugin_sample-3.8.0.tar.gz
Algorithm	Hash digest
SHA256	`87b295dda6deed0a59c8265614a78e07555335ad2c301f5900983d776be9692b`
MD5	`9af50fdda60ecace595b045b4dd2d692`
BLAKE2b-256	`5943c593f46f70e53420a1dc197e3ab74ded71157dff77c8b4021115f14e52e8`

See more details on using hashes here.

Provenance

The following attestation bundles were made for openedx_plugin_sample-3.8.0.tar.gz:

Publisher: release.yml on openedx/sample-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: openedx_plugin_sample-3.8.0.tar.gz
- Subject digest: 87b295dda6deed0a59c8265614a78e07555335ad2c301f5900983d776be9692b
- Sigstore transparency entry: 2676721605
- Sigstore integration time: Sep 1, 2026
Source repository:
- Permalink: openedx/sample-plugin@1f6766e215ba4615155664ee763c2ea6520121c5
- Branch / Tag: refs/heads/main
- Owner: https://github.com/openedx
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@1f6766e215ba4615155664ee763c2ea6520121c5
- Trigger Event: push