Unable to create a working plugin

Development
, , ,
1

I need to make minor changes like adding an Action Button on the User Admin page, change the contents of the Account Activation email and few others but my challenge is I have not been able to deploy a Django App which I could use for this purpose.

Then I noticed this example project and wants to leverage on it and add my features but still cannot successful deploy it and get it working. Following the instructions on the page all work well till I got to

2. add configuration data to custom models

tutor local run lms ./manage.py lms openedx_plugin_init
tutor local run lms ./manage.py lms openedx_plugin_api_init
tutor local run lms ./manage.py lms openedx_plugin_mobile_api_init
tutor local run cms ./manage.py cms openedx_plugin_cms_init

where “Unknown command: ‘openedx_plugin_init’” is returned for each of the commands. Please can someone help me?

2

Hi @pauldic could you please specify what version of Tutor you’re running, paste output of logs (in a formatted code block), and - if possible - provide a link to the plugin you’re trying to run?

1 Like
3

So, am working with tutor 20.0.0, edx teak.2. I have made some progress from the time I posted this. I had to clone and make few changes on the repository and ran these lines accordingly before build:

mkdir -p “$(tutor config printroot)/env/build/openedx/requirements”
touch “$(tutor config printroot)/env/build/openedx/requirements/private.txt”
echo “openedx-plugin-example” >> “$(tutor config printroot)/env/build/openedx/requirements/private.txt”
tutor config save --append OPENEDX_EXTRA_PIP_REQUIREMENTS=“git+https://github.com/open-craft/xblock-poll.git”
tutor config save --append OPENEDX_EXTRA_PIP_REQUIREMENTS=git+https://github.com/cookiecutter-openedx/openedx-plugin-example.git@main#egg=openedx-plugin-example&subdirectory=.&refresh=202508271400

The build and restarting get this successfully installed before running the migrations according to the docs.

I want to achieve 2 major things,

  1. inject a custom Action Button in the User Admin Page
  2. Override the User Account Activation email template so I can change the email verbiage

Please I will really appreciate your guide on this.

4

@pauldic could you clarify what the “User Admin Page” is? A screenshot would be helpful.

For the account activation email, did you try searching the forums? I found this, maybe it’s helpful? How can I persist edits to student/edx_ace/accountactivation/email/* so they survive Tutor rebuilds?

5

@sarina thank you, yes below is the User Admin Page I mean, though I have been able to sort out both issues after I successfully deploy the openedx-plugin-example. You are also right with How can I persist edits to student/edx_ace/accountactivation/email/* so they survive Tutor rebuilds? added my override here and everything is looking pretty good.

My breakthrough came after running:

mkdir -p “$(tutor config printroot)/env/build/openedx/requirements/”
echo “openedx-plugin-example” >> “$(tutor config printroot)/env/build/openedx/requirements/private.txt”

and

tutor config save --append OPENEDX_EXTRA_PIP_REQUIREMENTS=“git+https://github.com/open-craft/xblock-poll.git”
tutor config save --append OPENEDX_EXTRA_PIP_REQUIREMENTS=“git+https://github.com/cookiecutter-openedx/openedx-plugin-example.git@main#egg=openedx-plugin-example&subdirectory=.&refresh=202509111200”

Unfortunately the later is not in the documentation

image
image1903×450 26.6 KB