openedx.core.djangoapps.plugins package

Submodules

openedx.core.djangoapps.plugins.apps module

Plugins Application Configuration

Signal handlers are connected here.

class openedx.core.djangoapps.plugins.apps.PluginsConfig(app_name, app_module)

Bases: AppConfig

Application Configuration for Plugins.

name = 'openedx.core.djangoapps.plugins'

plugin_app = {}

ready()

Connect plugin receivers to their signals.

openedx.core.djangoapps.plugins.constants module

Constants used by django app plugins

class openedx.core.djangoapps.plugins.constants.ProjectType

Bases: object

The ProjectType enum defines the possible values for the Django Projects that are available in the edx-platform. Plugin apps use these values to declare explicitly which projects they are extending.

CMS = 'cms.djangoapp'

LMS = 'lms.djangoapp'

class openedx.core.djangoapps.plugins.constants.SettingsType

Bases: object

The SettingsType enum defines the possible values for the settings files that are available for extension in the edx-platform. Plugin apps use these values (in addition to ProjectType) to declare explicitly which settings (in the specified project) they are extending.

See openedx/edx-platform for further information on each Settings Type.

COMMON = 'common'

DEVSTACK = 'devstack'

PRODUCTION = 'production'

TEST = 'test'

Module contents