Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 1.57 KB

README_RUN.md

File metadata and controls

49 lines (27 loc) · 1.57 KB

Running the edX Generator

Important note:

WARNING: any existing contents in the output folder (i.e. in this case ./output/chapter) will be deleted.

WARNING: When you upload the .tar.gz file to edX, any existing course contents in edX will be deleted.

Make sure to save backups!

Dependencies

This Python3 script requires two python modules. These can be installed with pip as follows:

  • pip install markdown
  • pip install lxml

Markdown is processed using the python markdown module.

The following extensions are used:

Execution

There is the edx_generator.py Python script: It generates all the edX files which comprise the course, including the .tar.gz file for the import of the course into edX.

Execute the generator:

python ./edx_generator.py ./academy/input/course-starter ./output/course-starter

The __SETTINGS__.py file in the edX course root input folder specifies a set of global settings that you can set for your context.

WARNING: any existing contents in the output folder (i.e. in this case ./output/chapter) will be deleted.

Upload the .tar.gz File

After running the edX generator (assuming no errors), a tar.gz file will be generated. This file can be uploaded to the edX platform.

WARNING: When you upload the .tar.gz file to edX, any existing course contents in this edX course will be deleted.