Converter from Katacoda to Instruqt, it expects the katacoda content present in learn-katacoda dir. It expects track_scripts and config.yml templates present in the same level.

kataklisma.py

#!/usr/bin/python

# Katacoda to Instruqt converter


# v. 0.0.3
# Support for notes in first challenge, fix NodePort
#
# v. 0.0.2
# Support for bulk migrate with git submodule
#
# v. 0.0.1
# First draft
#

import os
import json
import yaml
import re
import shutil


# Instruqt will order the YAML and sanitize the YAML content (e.g. assignments)
# so there's no need to order the dict nor optimize the escaped block for non-YAML

track_d={}

visualEditor=False

with open('learn-katacoda/homepage-pathway.json', 'r') as hfile:
    hdata=hfile.read()

hcourses = json.loads(hdata)

for course in hcourses['courses']:
    pathway = course["external_link"].rsplit('/', 1)[-1]
    print("Creating or updating Topic : " + pathway)
    
    if not os.path.exists(pathway):
      os.mkdir(pathway)
      print("Directory " , pathway ,  " Created ")
    else:    
      print("Directory " , pathway ,  " already exists")
  
    print("Reading pathway " + 'learn-katacoda/' + pathway + '-pathway.json')
    with open('learn-katacoda/' + pathway + '-pathway.json', 'r') as myfile:
        data=myfile.read()

    courses = json.loads(data)

    for course in courses['courses']:
        pathway_id=''
        if "pathway_id" in course:
          pathway_id=course['pathway_id']
        else:
          pathway_id=pathway
        
        course_id=course['course_id']
        title=course['title']
        
        trackDir=course_id
        
        
        track_d["title"] = title
        track_d["slug"] = pathway + "-" + course_id
        track_d["type"] = "track"
        
        if not os.path.exists(pathway + '/' + trackDir):
          os.mkdir(pathway + '/' + trackDir)
          print("Directory " , pathway + '/' + trackDir ,  " Created ")
        else:    
          print("Directory " , pathway + '/' + trackDir ,  " already exists")
        
        
        try:
          with open('learn-katacoda/' + pathway_id + '/' + course_id + '/index.json', 'r') as mycourse:
              course_data=mycourse.read()
        except FileNotFoundError:
          print("Path " + 'learn-katacoda/' + pathway_id + '/' + course_id + '/index.json' + " not found, skipping")
          continue
        
        course_json = json.loads(course_data)
        
        track_d["icon"] = "https://logodix.com/logo/1910931.png"
        
        track_d["tags"] = ["openshift"]
        track_d["owner"] = "openshift"
        track_d["developers"] = [ "[email protected]", "[email protected]","[email protected]"]
        track_d["private"] =  False
        track_d["published"] = True
        track_d["skipping_enabled"] = False
        
        difficulty="intermediate"
        level="beginner"
        
        
        duration=re.match('(.*?)(-(.*?))? minutes', course_json["time"] )
        if duration is not None:
          time=duration.group(1)
          if duration.group(3) is not None:
              time=duration.group(3)
          time = int(time) * 60
        else:
          print("Time not found " + course_json["time"])
          time=300  
        
        level = course_json["difficulty"].lower()
        difficulty = course_json["difficulty"].lower()
        
        if level == "advanced":
          difficulty = "expert"
        elif level == "easy" or level == "beginner" or level == "basic":
          level = "beginner"
          difficulty = "basic"
        
        track_d["level"] = level
      
            
        l_challenges=[]
        d_challenges={}
        
        src=r'config.yml'
        dst= pathway + '/' + trackDir + '/' + 'config.yml'
        shutil.copyfile(src, dst)
        
        if os.path.exists(pathway + '/' + trackDir + '/track_scripts'):
          shutil.rmtree(pathway + '/' + trackDir + '/track_scripts')
        shutil.copytree('track_scripts', pathway + '/' + trackDir + '/track_scripts')
        
        if not os.path.exists(pathway + '/' + trackDir + '/assets'):
          os.mkdir(pathway + '/' + trackDir + '/assets')
          
        if not os.path.exists(pathway + '/' + trackDir + '/scripts'):
          os.mkdir(pathway + '/' + trackDir + '/scripts')

        
        introText=course_json["details"]["intro"]["text"]
        with open('learn-katacoda/' + pathway_id + '/' + course_id + '/' + introText, 'r') as myintro:
          intro_data=myintro.read()
        
        intro_md=re.sub(r'\(\.\.\/\.\.\/assets',r'(https://katacoda.com/openshift/assets',intro_data)
        intro_md=re.sub(r'\(\/openshift\/assets',r'(https://katacoda.com/openshift/assets',intro_data)

        track_d["description"] = intro_md
        
        #for asset in course_json["assets"]["clients"]:
        #    script=asset["file"]
        
        try:
          assets = course_json["details"]["assets"]["client"]
          #shutil.copyfile('learn-katacoda/' + pathway_id + '/' + course_id + '/assets/*' , pathway + '/' + trackDir + '/track_scripts/')
          os.system('cp -fr ' + 'learn-katacoda/' + pathway_id + '/' + course_id + '/assets/* ' + pathway + '/' + trackDir + '/scripts/' )
          print('cp -fr ' + 'learn-katacoda/' + pathway_id + '/' + course_id + '/assets/* ' + pathway + '/' + trackDir + '/scripts/')
        except KeyError:
          pass
        
        if course_json["environment"]["uilayout"] == "editor-terminal":
          visualEditor=True
        
        l_steps = course_json["details"]["steps"]
        l_size = len(l_steps)
        time = int(int(time) / l_size)
        
        isFirstStep=True
        
        for step in l_steps:
            slug = step["text"]
            
            slug = re.sub(r'\.md$', '', slug )
            
            if not os.path.exists(pathway + '/' + trackDir + '/' + slug):
              os.mkdir(pathway + '/' + trackDir + '/' + slug)
              print("Directory " , pathway + '/' + trackDir + '/' + slug ,  " Created ")
            else:    
              print("Directory " , pathway + '/' + trackDir + '/' + slug ,  " already exists")
            
            
            d_challenges["slug"] = slug
            d_challenges["title"] = step["title"]
            d_challenges["type"] = "challenge"
            
            with open('learn-katacoda/' + pathway_id + '/' + course_id + '/' + step["text"], 'r') as myassign:
                assign_data=myassign.read()
            
            md=re.sub(r'`{1,3}(.+?)`{1,3}\{\{execute\}\}', r'```\n\1\n```', assign_data )
            md=re.sub(r'\{\{copy\}\}',r'', md)
            md=re.sub(r'\{\{open\}\}',r'', md)
            md=re.sub(r'\(\.\.\/\.\.\/assets',r'(https://katacoda.com/openshift/assets',md)
            md=re.sub(r'\(\/openshift\/assets',r'(https://katacoda.com/openshift/assets',md)
            
            d_challenges["assignment"] =  md
            
            if isFirstStep:
                l_notes = [{"type": "text", "contents": intro_md}]
                d_challenges["notes"] =  l_notes
                isFirstStep=False
            else:
                if "notes" in d_challenges:
                    del d_challenges["notes"]


            l_tabs = [{"title": "CLI", "type": "terminal","hostname":"crc"},
                      {"title": "Web Console", "type" : "service", "hostname" : "crc", "path" : "/", "port" : 30001}]
            
            if visualEditor:
              l_tabs.append({"title": "Visual Editor", "type": "code","hostname":"crc", "path":"/root"})
            
            d_challenges["tabs"] = l_tabs
            
            d_challenges["difficulty"]= difficulty
            d_challenges["timelimit"]= time
            
            dictionary_copy = d_challenges. copy()
            l_challenges.append(dictionary_copy);
            


        
        track_d["challenges"] = l_challenges
        
        with open(pathway + '/' + trackDir + '/track.yml', 'w') as yaml_file:
          yaml.dump(track_d, yaml_file, default_flow_style=False)