This section describes how to get started with the XBlock SDK.
The XBlock SDK is a Python application you use to help you build new XBlocks. The XBlock SDK contains three main components:
An XBlock creation tool that builds the skeleton of a new XBlock.
An XBlock runtime for viewing and testing your XBlocks during development.
Sample XBlocks that you can use as the starting point for new XBlocks, and for your own learning.
xblock_development directory, run the following command to clone
the XBlock SDK repository from GitHub.
(venv) $ git clone https://github.com/openedx/xblock-sdk.git
Run the following command to change to the
(venv) $ cd xblock-sdk
Run the following command to install the XBlock SDK requirements.
(venv) $ pip install -r requirements/base.txt
Run the following command to return to the
where you will perform the rest of your work.
(venv) $ cd ..
You use the XBlock SDK to create skeleton files for an XBlock. To do this, follow these steps at a command prompt.
Change to the
xblock_development directory, which contains the
Run the following command to create the skeleton files for the XBlock.
(venv) $ xblock-sdk/bin/workbench-make-xblock
Instructions in the command window instruct you to determine a short name and a class name. Follow the guidelines in the command window to determine the names that you want to use.
You will be prompted for two pieces of information: * Short name: a single word, all lower-case, for directory and file names. For a hologram 3-D XBlock, you might choose "holo3d". * Class name: a valid Python class name. It's best if this ends with "XBlock", so for our hologram XBlock, you might choose "Hologram3dXBlock". Once you specify those two names, a directory is created in the ``xblock_development`` directory containing the new project. If you don't want to create the project here, or you enter a name incorrectly, type Ctrl-C to stop the creation script. If you don't want the resulting project, delete the directory it created.
At the command prompt, enter the Short Name you selected for your XBlock.
$ Short name: myxblock
At the command prompt, enter the Class name you selected for your XBlock.
$ Class name: MyXBlock
The skeleton files for the XBlock are created in the
For more information about the XBlock files, see
Anatomy of an XBlock.
After you create the XBlock, you install it in the XBlock SDK.
xblock_development directory, use
pip to install your XBlock.
(venv) $ pip install -e myxblock
You can then test your XBlock in the XBlock SDK.
Before running the XBlock SDK the first time, you must create the SQLite database.
xblock_development directory, run the following command to create
the database and the tables.
(venv) $ python xblock-sdk/manage.py migrate
You are prompted to indicate whether or not to create a Django superuser.
You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no):
To see the web interface of the XBlock SDK, you must run the SDK server.
xblock_development directory, run the following command to start the
(venv) $ python xblock-sdk/manage.py runserver
If you do not specify a port, the XBlock SDK server uses port 8000.
To use a different port, specify it in the
Then test that the XBlock SDK is running. In a browser, go to
http://localhost:8000. You should see the following page.
The page shows the XBlocks installed automatically with the XBlock SDK. Note that the page also shows the MyXBlock XBlock that you created in Create Your First XBlock.
To get help for the XBlock SDK
runserver command, run the following
(venv) $ python xblock-sdk/manage.py help
The command window lists and describes the available commands.