-
Notifications
You must be signed in to change notification settings - Fork 3
/
convert_gemtext_file.py
107 lines (95 loc) · 3.77 KB
/
convert_gemtext_file.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
#!/usr/bin/env python
"""
HUNTER'S SIMPLE GEMTEXT TO HTML CONVERTER
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A simple script that converts gemtext to HTML. Takes two arguments from stdin -
args[1](gmi) is an input gemtext file and args[2](html) is an output HTML file.
You can run it like
python3 input.gmi output.html
The output file consists of only the lines of gemtext in the input file converted
to their HTML equivalents: <h1>, <h2>, <h3>, <p>, <a>, <blockquote>, <li>, and
<pre> tags. It does not include any boilerplate such as a default <head>
or wrapping <html> or <body> tags. I wrote it mainly so I could insert converted
gemtext into a webpage I already started using copy-paste or a templating system
like Jinja. Extend it as you see fit.
If you have any suggestions on how to make it better you can reach me at
hunterkb@ksu.edu
"""
# importing required libraries
import contextlib
import sys
import re
# A dictionary that maps regex to match at the beginning of gmi lines to their corresponding HTML tag names. Used by convert_single_line().
tags_dict = {
r"^# (.*)": "h1",
r"^## (.*)": "h2",
r"^### (.*)": "h3",
r"^\* (.*)": "li",
r"^> (.*)": "blockquote",
r"^=>\s*(\S+)(\s+.*)?": "a"
}
# This function takes a string of gemtext as input and returns a string of HTML
def convert_single_line(gmi_line):
for pattern in tags_dict.keys():
if match := re.match(pattern, gmi_line):
tag = tags_dict[pattern]
groups = match.groups()
if tag == "a":
href = groups[0]
inner_text = groups[1].strip() if len(groups) > 1 else href
return f"<{tag} href='{href}'>{inner_text}</{tag}>"
else:
inner_text = groups[0].strip()
return f"<{tag}>{inner_text}</{tag}>"
return f"<p>{gmi_line}</p>"
# smart open for stdin & stdout
# credit to https://stackoverflow.com/a/17603000/15956024
@contextlib.contextmanager
def smart_open(file_name=None, encoding='r'):
if file_name and file_name != 'STDIN' and file_name != 'STDOUT':
fh = open(file_name, encoding)
elif file_name == 'STDIN':
fh = sys.stdin
elif file_name == 'STDOUT':
fh = sys.stdout
else:
# will never reach here
pass
try:
yield fh
finally:
if fh is not sys.stdin or fh is not sys.stdout:
fh.close()
# Reads the contents of the input file line by line and outputs HTML. Renders text in preformat blocks (toggled by ```) as multiline <pre> tags.
def main(args):
input = args[1] if len(args) > 1 else "STDIN"
output = args[2] if len(args) > 2 else "STDOUT"
with smart_open(input) as gmi, smart_open(output) as html:
preformat = False
in_list = False
for line in gmi:
line = line.strip()
if len(line):
if line.startswith("```") or line.endswith("```"):
preformat = not preformat
repl = "<pre>" if preformat else "</pre>"
html.write(re.sub(r"```", repl, line))
elif preformat:
html.write(line)
else:
html_line = convert_single_line(line)
if html_line.startswith("<li>"):
if not in_list:
in_list = True
html.write("<ul>\n")
html.write(html_line)
elif in_list:
in_list = False
html.write("</ul>\n")
html.write(html_line)
else:
html.write(html_line)
html.write("\n")
# Main guard
if __name__ == "__main__":
main(sys.argv)