indexer.py

# run this to scrape the notebooks for keywords and create and index

import os
import json

index = {'Topics':{},'Commands':{}}
for path, dirs, files in os.walk(os.getcwd()):
    for file in files:
        if file[-6:]=='.ipynb':
            with open(path+'/'+file) as json_file:  
                data = str(json.load(json_file))
                start = data.find('keywords = ')
                if (file!='indexer.ipynb') and('checkpoint' not in file) and start!=-1:
                    data = data[(start+11):]
                    end = data.find("}")
                    data = data[:(end+1)]
                    keywords = eval(data)
                    rpath = (path+'/'+file).split('qiskit-tutorials/')[1]
                    for kw_type in index:
                        for topic in keywords[kw_type]:
                            try:
                                index[kw_type][topic].append(rpath)
                            except:
                                index[kw_type][topic] = [rpath]
                                
md = 'The following lists show notebooks in the Qiskit tutorials that are relevant for various keywords. Note that these lists only include notebooks for which these keywords have been added.\n\n'                          
for kw_type in ['Commands','Topics']:
    md += '\n## Index by '+kw_type+'\n\n'
    for kw in sorted(index[kw_type]):
        entry = '### ' + kw
        for rpath in sorted(index[kw_type][kw]):
            entry += '\n* [' + rpath.split('/')[-1].split('.')[0].replace('_',' ') + '](' + rpath + ')'
        md += entry+'\n\n'

with open('index.md','w') as file:
    file.write(md)