-
Notifications
You must be signed in to change notification settings - Fork 0
/
coursemaker.py
245 lines (197 loc) · 9.42 KB
/
coursemaker.py
1
2
3
4
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
import argparse
import json
import re
import shutil
import subprocess
import sys
import tempfile
from pathlib import Path
import markdown
import tomli
import yaml
from bs4 import BeautifulSoup
def parse_args():
parser = argparse.ArgumentParser(description="Tool to make capstone course from other formats")
parser.add_argument("-f", "--format", help="The source format to convert from", required=True, choices=["mkdocs", "mdbook"])
parser.add_argument("-o", "--output", help="The output directory (default: %(default)s)", default="capstone-course")
parser.add_argument("directory", help="The directory to convert from")
return parser.parse_args()
def from_mdbook(directory, output):
book_conf = tomli.loads((Path(directory) / "book.toml").read_text())["book"]
src = book_conf.get("src", "src")
title = book_conf["title"]
name = slugify(title)
src_dir = Path(directory) / src
output_dir = Path(output)
if output_dir.is_dir() and not list(output_dir.iterdir()) == []:
raise ValueError(f"Output directory exists and is not empty: {output_dir}")
modules = []
summary_md_text = (src_dir / "SUMMARY.md").read_text()
summary_html = markdown.markdown(
summary_md_text,
tab_length=infer_tab_length(summary_md_text),
)
soup = BeautifulSoup(summary_html, "html.parser")
module_soups = [li for module_group in soup.find_all("ul", recursive=False) for li in module_group.find_all("li", recursive=False)]
for (i, module_soup) in enumerate(module_soups, start=1):
if (module_with_link := module_soup.find("a")):
module_title = module_with_link.contents[0].string
assert module_title is not None # sanity check
module_link = module_with_link.attrs["href"]
module = dict(
name=slugify(module_title),
title=module_title,
lessons=[
dict(name=slugify(module_title), title=module_title, path=src_dir / module_link),
],
)
else:
module_title = f"Module {i}"
module = dict(name=slugify(module_title), title=module_title, lessons=[])
# elements of sublists inside module soup, and their sublists, etc.
for lesson_soup in module_soup.find_all("li"):
# only add lessons with links
if (lesson_with_link := lesson_soup.contents[0]).name == "a":
lesson_title = lesson_with_link.contents[0].string
assert lesson_title is not None
lesson_link = lesson_with_link.attrs["href"]
module["lessons"].append(
dict(name=slugify(lesson_title), title=lesson_title, path=src_dir / lesson_link)
)
modules.append(module)
# write to tempdir first. then rename it to output_dir if that succeeds
with tempfile.TemporaryDirectory() as tmp:
course_path = Path(tmp)
package_metadata = dict(kind="course", version="0.1", name=name, title=title)
(course_path / "metadata.json").write_text(json.dumps(package_metadata))
contents_path = course_path / "contents"
contents_path.mkdir()
lessons_path = contents_path / "lessons"
lessons_path.mkdir()
for module in modules:
new_module_path = lessons_path / module["name"]
new_module_path.mkdir()
for lesson in module["lessons"]:
new_lesson_path = new_module_path / f"{lesson['name']}.html"
new_lesson_path.write_text(md_to_html(lesson["path"].read_text()))
lesson["path"] = str(new_lesson_path.relative_to(contents_path))
course_metadata = dict(name=name, title=title, description=title, modules=modules)
(contents_path / "course.json").write_text(json.dumps(course_metadata))
shutil.move(course_path, output_dir)
print(json.dumps(course_metadata, indent=4))
def from_mkdocs(directory, output):
directory = Path(directory)
mkdocs_conf = yaml.safe_load((directory / "mkdocs.yml").read_text())
title = mkdocs_conf["site_name"]
name = slugify(title)
output_dir = Path(output)
if output_dir.is_dir() and not list(output_dir.iterdir()) == []:
raise ValueError(f"Output directory exists and is not empty: {output_dir}")
with tempfile.TemporaryDirectory() as tmp:
site_dir = Path(tmp) / "site"
subprocess.check_call(
[sys.executable, "-m", "mkdocs", "build", "--site-dir", site_dir],
cwd=directory
)
index_soup = BeautifulSoup((site_dir / "index.html").read_text(), "html.parser")
styles = []
for element in index_soup.find_all("link", {"rel": "stylesheet"}):
href = element.attrs["href"]
if href and href.startswith("assets/stylesheets"):
# ignore mkdocs styles (except plugins)
continue
if not is_relative_url(href):
# convert relative paths to in-terms of media directory
element.attrs["href"] = str(Path("../../media") / href)
styles.append(element)
scripts = []
for element in index_soup.find_all("script"):
src = element.attrs.get("src")
if src and src.startswith("assets/javascripts"):
# ignore default mkdocs scripts (but not plugins)
continue
if src and not is_relative_url(src):
# convert relative paths to in-terms of media directory
element.attrs["src"] = str(Path("../../media") / src)
scripts.append(element)
modules = []
elements = index_soup.find(class_="md-nav--primary").find("ul", class_="md-nav__list").find_all("li", recursive=False)
for li in elements:
module_link = li.find("a", class_="md-nav__link", recursive=False) or li.find(class_="md-nav__link", recursive=False)
module_title = next(s for s in module_link.stripped_strings if s)
module_name = slugify(module_title)
module = dict(name=module_name, title=module_title)
if module_link.name == "a":
module["lessons"] = [{
"name": module_name,
"title": module_title,
"path": Path(module_link.attrs["href"]) / "index.html"
}]
else:
module["lessons"] = [
{
"name": slugify(lesson_link.string.strip()),
"title": lesson_link.string.strip(),
"path": Path(lesson_link.attrs["href"]) / "index.html"
}
for lesson_link in li.find_all("a", class_="md-nav__link")
]
modules.append(module)
for module in modules:
for lesson in module["lessons"]:
lesson_path = site_dir / lesson["path"]
lesson_soup = BeautifulSoup(lesson_path.read_text(), "html.parser")
for img in lesson_soup.find_all("img"):
if is_relative_url(img.attrs["src"]):
img.attrs["src"] = str("../../media" / lesson["path"].parent / img.attrs["src"])
lesson_path.write_text(
lesson_soup.find("div", class_="md-content").prettify()
+ "\n"
+ "".join([s.prettify() for s in styles])
+ "".join([s.prettify() for s in scripts])
)
course_path = Path(tmp) / "package"
course_path.mkdir()
package_metadata = dict(kind="course", version="0.1", name=name, title=title)
(course_path/ "metadata.json").write_text(json.dumps(package_metadata))
contents_path = course_path / "contents"
contents_path.mkdir()
lessons_path = contents_path / "lessons"
lessons_path.mkdir()
for module in modules:
new_module_path = lessons_path / module["name"]
new_module_path.mkdir()
for lesson in module["lessons"]:
lesson_path = site_dir / lesson["path"]
new_lesson_path = new_module_path / f"{lesson['name']}.html"
new_lesson_path.write_text(lesson_path.read_text())
lesson["path"] = str(new_lesson_path.relative_to(contents_path))
course_metadata = dict(name=name, title=title, description=title, modules=modules)
(contents_path / "course.json").write_text(json.dumps(course_metadata))
shutil.move(site_dir, contents_path / "media")
shutil.move(course_path, output_dir)
def slugify(s):
not_allowed_chars = re.compile(r"[^a-zA-Z0-9-]")
return not_allowed_chars.sub("", s.lower().replace(" ", "-"))
def md_to_html(text):
return markdown.markdown(text, tab_length=4, extensions=["extra", "codehilite"])
def infer_tab_length(text):
"""infer tab length, either 2 or 4 (default fallback: 2)"""
for line in text.splitlines():
if line.startswith(" "):
return 4
return 2
def is_relative_url(url):
return not url.startswith("http")
def main():
args = parse_args()
match args.format:
case "mdbook":
from_mdbook(args.directory, args.output)
case "mkdocs":
from_mkdocs(args.directory, args.output)
case _:
raise ValueError(f"Unknown format: {args.format}")
print("Generated the course in directory", args.output)
if __name__ == "__main__":
main()