ol-openedx-uai-content-customization 0.4.0

Course Key Format

course-v1:ORG+NUMBER.<DURATION>[.<INDUSTRY>]+RUN

For the Original industry, no industry code is appended:

course-v1:UAI_SOURCE+UAI.3.S+1T2026   ← Original, Short
course-v1:UAI_SOURCE+UAI.3.F+1T2026   ← Original, Full
course-v1:UAI_SOURCE+UAI.3.S.HC+1T2026 ← Healthcare, Short

Course Structure

Each generated course has the following structure:

Course (<display name>)
├── Introduction  (section, optional)
    └── Introduction  (subsection)
        └── Introduction  (unit)
            └── Introduction  (HTML block)
└── Lectures  (section)
    └── <Video Title>  (subsection)
        └── <Video Title>  (unit)
            └── <Video Title>  (video block with edX video ID)

Prerequisites

You will need a single CSV file:

Processed videos CSV — produced by the video customization workflow. Required columns:

• course_key — the Open edX course key of the source course to clone (e.g. course-v1:UAI_SOURCE+UAI.2+1T2026). This course must already exist in the CMS modulestore before the command runs. The command validates all source keys up-front and aborts with an error if any are missing.

• industry — one of: Healthcare, Finance, Energy, Original

• duration — short or long

• video_file_name — file name of the video (for reference/display)

• video_title — display name for the subsection/unit/video

• module_name — used to build the course display name

• edx_video_id — the Open edX UUID for the video (exported from Studio / OVS after uploading the customized video)

• course_intro — optional introduction content for the generated course. If this value contains HTML tags, it is used as-is. If it is plain text, the command HTML-escapes it and wraps it in <p>...</p>.

  Intro resolution precedence for each generated (course_key, industry, duration) variant:

  1. exact match on (course_key, industry, duration)

  2. fallback to (course_key, industry) (industry-only intro, reused for both short and long)

  3. fallback to (course_key, Original industry) (reused across all industries and durations for that source course)

  If no intro is resolved, no Introduction section is created for that variant.

Running the Command

Run the management command from inside the CMS container (e.g. Tutor dev shell):

python manage.py cms generate_uai_course_versions \
    --processed-videos-csv /path/to/processed_videos.csv \
    [--username studio_worker] \
    [--dry-run]

--processed-videos-csv also accepts the URL of a publicly readable Google Sheet, so you can point the command directly at the sheet instead of downloading a CSV first:

python manage.py cms generate_uai_course_versions \
    --processed-videos-csv "https://docs.google.com/spreadsheets/d/<SHEET_ID>/edit#gid=0" \
    [--username studio_worker] \
    [--dry-run]

The sheet must be shared as “Anyone with the link can view” (or published to the web). Any standard docs.google.com share/edit link works — the command derives the CSV export link automatically, using the gid from the URL to select the right tab. Only docs.google.com Sheets links are accepted; any other http(s) URL is rejected with an error.

Options

--processed-videos-csv

Path to the processed video metadata CSV file, or the URL of a publicly readable Google Sheet (docs.google.com share/edit or export link — no other URL is accepted). Required.

--username

Username of the platform user under whose authority the courses are created. Defaults to studio_worker.

--dry-run

Print what would be created without writing anything to the modulestore. Use this to verify CSV mapping before committing.

How It Works

For each unique (course_key, industry, duration) group the command:

1. Validates all source course keys against the live modulestore before making any writes (fail-fast — aborts if any source is missing).

2. Clones the source course into the new UAI-specific key, inheriting all course settings.

3. Deletes every existing section (chapter) from the clone.

4. Rebuilds the content tree from the CSV rows:

   Course  (cloned — settings inherited)
   ├── Introduction  (optional, created only when ``course_intro`` resolves)
       └── Introduction  (subsection)
           └── Introduction  (unit)
               └── Introduction  (HTML block)
   └── Lectures  (section)
       └── <Video Title>  (subsection)
           └── <Video Title>  (unit)
               └── <Video Title>  (video block)

5. Publishes the course.