generateIndex.py 5.74 KB
Newer Older
1
2
3

import os, re

Laurent Heirendt's avatar
Laurent Heirendt committed
4
folder = "internal"
Laurent Heirendt's avatar
Laurent Heirendt committed
5

6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def line_prepender(filename, line):
    with open(filename, 'r+') as f:
        content = f.read()
        f.seek(0, 0)
        f.write(line.rstrip('\r\n') + '\n' + content)

def remove_header(localroot, root, filename, n=5):
    nfirstlines = []

    #cwd = os.getcwd()

    os.chdir(localroot)
    #print("Local root folder:" + os.getcwd())

    os.chdir(root)
    #print("Local folder:" + os.getcwd())

    # count the number of lines
    count = 0
    headerCheck = False
    with open(filename, 'r') as f:
        for line in f:
            count += 1

            # check if the header is actually a header
            if (count == 0 or count == n) and line[0:3] == "---":
                headerCheck = True

    # remove the header
    if count > n and headerCheck:
        with open(filename) as f, open("tmp"+filename, "w") as out:
            for _ in range(n):
                nfirstlines.append(next(f))
            for line in f:
                out.write(line)

        os.remove(filename)
        os.rename("tmp"+filename, filename)
44
        print(" - Old header removed.")
45
46
47
48
49
50
51

    # change back to the local root
    os.chdir(localroot)
    #print("exit folder:" + os.getcwd())

# loop through the entire internal tree
localroot = os.getcwd()
52

Laurent Heirendt's avatar
Laurent Heirendt committed
53
54

# generate the index properly speaking
Laurent Heirendt's avatar
Laurent Heirendt committed
55
56
57
58
59
60
61
62
63
64
cardDirs = ["internal", "external"]
sections = []

# determine first the directories
for direct in cardDirs:
    dirs = os.listdir(direct)

    for d in dirs:
        if d[0] != ".":
            sections.append(d)
Laurent Heirendt's avatar
Laurent Heirendt committed
65

Laurent Heirendt's avatar
Laurent Heirendt committed
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
sections = list(set(sections))
sections.sort()

index = ""
localIndexArr = [[]] * len(sections)
for folder in cardDirs:

    # check here if folder exists
    dirs = os.listdir(folder)
    dirs = sorted(dirs)

    for d in dirs:
        if d[0] != ".":
            # set the header of the section
            #index += "\n### " + d.replace("-", " ").capitalize() + "\n"


            # get the index of the section
            indexS = sections.index(d)

            #print(indexS)
            if len(localIndexArr[indexS]) == 0:
                localIndexArr[indexS] = ["\n"]

            # walk through the folders with all the cards
            for root, dirs, files in os.walk(folder+"/"+d):
                for file in files:
                    if file.endswith(".md"):
                        fileName = os.path.join(root, file)

                        # ignore subsections (.md files that start with _)
                        if file[0] != "_":
                            print(" > Generating header for: " + fileName)

                            # remove the previous header
                            remove_header(localroot, root, file, 8)

                            # generate a permalink
                            permalink = "/" + root + "/"

                            # generate the shortcut
                            shortcut = re.sub(folder, '', root)

                            # remove the first /
                            shortcut = shortcut[1:]

                            # replace the / with a :
                            shortcut = re.sub('/', ':', shortcut)

                            # define the header for each card
                            header = "---\n"
                            header += "layout: page\n"
                            header += "permalink: " + permalink + "\n"
                            header += "shortcut: " + shortcut + "\n"
                            header += "redirect_from:\n"
                            header += "  - /cards/" + shortcut + "\n"
                            header += "  - /internal/cards/" + shortcut + "\n"
                            header += "---"

                            # add the header properly speaking
                            line_prepender(fileName, header)

                            # open file and get the title after the header
                            count = 0
                            title = ""
                            bp = 9
                            with open(fileName, 'r') as f:
                                for line in f:
                                    count += 1
                                    if count == bp:
                                        if len(line) > 2:
                                            title = line
                                            break
                                        else:
                                            bp += 1

                            # remove first and last chars
                            title = title.rstrip("\n\r")
                            title = title[2:]

                            #index += "  * [" + title + "](./" + root + "/" + "\n"
                            localIndexArr[indexS].append("* [" + title + "](./" + root + "/" + ")\n")

                            # output
                            print(" + New header added.")
                            print("-----------------------")

            # join all subcategories to the index
            localIndexArr[indexS].sort()
            #index += ''.join(localIndexArr)

print(localIndexArr)

# determine the index
k = 0
for s in sections:
    index += "\n### " + s.replace("-", " ").capitalize() + "\n"
    index += ''.join(localIndexArr[k])
    k += 1
Laurent Heirendt's avatar
Laurent Heirendt committed
165

166
# output the index
Laurent Heirendt's avatar
Laurent Heirendt committed
167
168
169
#print(index)
# Read in the file
indexFile = "index.md"
170
filedata = ""
Laurent Heirendt's avatar
Laurent Heirendt committed
171
with open(indexFile, 'r') as file :
172
173
174
175
176
177
178
    for line in file:
        filedata += line

        # stop reading once the index place holder has been reached
        if re.search("<!-- index -->", line):
            filedata += "[[ index ]]"
            break
Laurent Heirendt's avatar
Laurent Heirendt committed
179
180
181
182
183
184

# Replace the target string
filedata = filedata.replace('[[ index ]]', index)

# Write the file out again
with open(indexFile, 'w') as file:
Laurent Heirendt's avatar
Laurent Heirendt committed
185
186
187
  file.write(filedata)

print("\n > New index generated and saved in " + indexFile)