XBlock - Cannot create the skeleton files from calling workbench-make-xblock

Development Architecture
1

Hi, I try to create custom XBlock but it is not successful when I called to create the skeleton files workbench-make-xblock

Here are steps I made:

  1. I setup the SDK dev from this page https://docs.openedx.org/projects/xblock/en/latest/xblock-tutorial/getting_started/setup_sdk.html. And because my machine is window, I change the make install command to be
(venv) C:\xblock_development\xblock-sdk>pip install -qr requirements\dev.txt
	[notice] A new release of pip is available: 24.0 -> 24.2
	[notice] To update, run: python.exe -m pip install --upgrade pip

	(venv) C:\xblock_development\xblock-sdk>pip install -qr requirements\local.txt
	[notice] A new release of pip is available: 24.0 -> 24.2
	[notice] To update, run: python.exe -m pip install --upgrade pip
	(venv) C:\xblock_development\xblock-sdk>
  1. I learn how to create custom-xblock from this page https://docs.openedx.org/projects/xblock/en/latest/xblock-tutorial/getting_started/create_first_xblock.html When I call workbench-make-xblock to create the skeleton files, it shows an error as follow:
(venv) C:\xblock_development>.\xblock-sdk\bin\workbench-make-xblock
'.\xblock-sdk\bin\workbench-make-xblock' is not recognized as an internal or external command,
operable program or batch file.

Is there any thing I have been missing?

In addition, I tried create a custom xblock using this command xblock-sdk create my_custom_xblock from this page https://appsembler.com/blog/xblocks-plugins-for-open-edx/#h-introduction. It does not work for my machine too.

Please help. Thank you very much in advance for all your supports.

2

Try the command python .\xblock-sdk\bin\workbench-make-xblock . The docs were written assuming you’re on a UNIX system, not Windows. The Windows shell doesn’t “know” how to read the first line (shebang) of the file in order to determine which interpreter to use (python).

However, you may run into more issues like this because:

  1. The workbench is not really used or maintained much as far as I know, and
  2. Very few XBlock developers use Windows so it may not be working or well tested on that OS.
3

Thanks a lot.