mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-11-14 09:14:14 +00:00
15b219e235
This is a very large refactoring which aims at making Tutor both more extendable and more generic. Historically, the Tutor plugin system was designed as an ad-hoc solution to allow developers to modify their own Open edX platforms without having to fork Tutor. The plugin API was simple, but limited, because of its ad-hoc nature. As a consequence, there were many things that plugin developers could not do, such as extending different parts of the CLI or adding custom template filters. Here, we refactor the whole codebase to make use of a generic plugin system. This system was inspired by the Wordpress plugin API and the Open edX "hooks and filters" API. The various components are added to a small core thanks to a set of actions and filters. Actions are callback functions that can be triggered at different points of the application lifecycle. Filters are functions that modify some data. Both actions and filters are collectively named as "hooks". Hooks can optionally be created within a certain context, which makes it easier to keep track of which application created which callback. This new hooks system allows us to provide a Python API that developers can use to extend their applications. The API reference is added to the documentation, along with a new plugin development tutorial. The plugin v0 API remains supported for backward compatibility of existing plugins. Done: - Do not load commands from plugins which are not enabled. - Load enabled plugins once on start. - Implement contexts for actions and filters, which allow us to keep track of the source of every hook. - Migrate patches - Migrate commands - Migrate plugin detection - Migrate templates_root - Migrate config - Migrate template environment globals and filters - Migrate hooks to tasks - Generate hook documentation - Generate patch reference documentation - Add the concept of action priority Close #499.
88 lines
1.8 KiB
ReStructuredText
88 lines
1.8 KiB
ReStructuredText
.. _plugins_examples:
|
|
|
|
========
|
|
Examples
|
|
========
|
|
|
|
The following are simple examples of :ref:`Tutor plugins <plugins>` that can be used to modify the behaviour of Open edX.
|
|
|
|
Skip email validation for new users
|
|
===================================
|
|
|
|
::
|
|
|
|
from tutor import hooks
|
|
|
|
hooks.Filters.ENV_PATCHES.add_item(
|
|
(
|
|
"common-env-features",
|
|
"""
|
|
"SKIP_EMAIL_VALIDATION": true
|
|
""""
|
|
)
|
|
)
|
|
|
|
Enable bulk enrollment view in the LMS
|
|
======================================
|
|
|
|
::
|
|
|
|
from tutor import hooks
|
|
|
|
hooks.Filters.ENV_PATCHES.add_item(
|
|
(
|
|
"lms-env-features",
|
|
"""
|
|
"ENABLE_BULK_ENROLLMENT_VIEW": true
|
|
"""
|
|
)
|
|
)
|
|
|
|
Enable Google Analytics
|
|
=======================
|
|
|
|
::
|
|
|
|
from tutor import hooks
|
|
|
|
hooks.Filters.ENV_PATCHES.add_item(
|
|
(
|
|
"openedx-common-settings",
|
|
"""
|
|
# googleanalytics special settings
|
|
GOOGLE_ANALYTICS_ACCOUNT = "UA-your-account"
|
|
GOOGLE_ANALYTICS_TRACKING_ID = "UA-your-tracking-id"
|
|
"""
|
|
)
|
|
)
|
|
|
|
Enable SAML authentication
|
|
==========================
|
|
|
|
::
|
|
|
|
from tutor import hooks
|
|
|
|
hooks.Filters.ENV_PATCHES.add_items([
|
|
(
|
|
"common-env-features",
|
|
'"ENABLE_THIRD_PARTY_AUTH": true',
|
|
),
|
|
(
|
|
"openedx-lms-common-settings:",
|
|
"""
|
|
# saml special settings
|
|
AUTHENTICATION_BACKENDS += ["common.djangoapps.third_party_auth.saml.SAMLAuthBackend", "django.contrib.auth.backends.ModelBackend"]
|
|
"""
|
|
),
|
|
(
|
|
"openedx-auth",
|
|
"""
|
|
"SOCIAL_AUTH_SAML_SP_PRIVATE_KEY": "yoursecretkey",
|
|
"SOCIAL_AUTH_SAML_SP_PUBLIC_CERT": "yourpubliccert"
|
|
"""
|
|
),
|
|
])
|
|
|
|
Do not forget to replace "yoursecretkey" and "yourpubliccert" with your own values.
|