Django Plugins and Filters

Django Plugins and Filters#

Django plugins are one of the most valuable extension mechanisms for the Open edX platform. In this section, we will guide you through the process of using filters inside your own plugin.

Use Filters Inside Your Plugin#

Imagine you have your own registration plugin, and you want to add a filter to it. The first thing you need to do is add openedx-filters to your requirements file. Then, you can import the registration filter and use it inside your registration flow as it is used in the LMS registration flow. After implementing their definitions in your plugin, you can even add your filters to your registration.

Configure Filters#

Filters are configured in the OPEN_EDX_FILTERS_CONFIG dictionary, which can be specified in your plugin’s settings file for testig purposes. The dictionary has the following structure:

OPEN_EDX_FILTERS_CONFIG = {
    "<FILTER EVENT TYPE>": {
        "fail_silently": <BOOLEAN>,
        "pipeline": [
            "<STEP NAME 0>",
            "<STEP NAME 1>",
            ...
            "<STEP NAME N-1>",
        ]
    },
}

In a production environment, you’ll have to add this config to your edx-platform settings file.

To learm more about this, visit Filter Configurations.

Create Pipeline Steps#

In your own plugin, you can create your own pipeline steps by inheriting from PipelineStep and implementing the run_filter method. You can find examples of pipeline steps in the openedx-filters-samples repository. See Quickstarts for more details.

Maintenance chart

Review Date

Reviewer

Release

Test situation

2025-02-13

Maria Grimaldi

Sumac

Pass.
Contents