A naive but enjoyable static site generator

bartek · bartek · commit d176053809e7 · 2019-11-17T21:53:48.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+__pycache__
diff --git a/blog/__init__.py b/blog/__init__.py
diff --git a/blog/flatpages.py b/blog/flatpages.py
@@ -0,0 +1,81 @@
+import logging
+import os
+from itertools import takewhile
+from typing import List
+
+import markdown
+import yaml
+from flask import Flask
+
+BASE_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), '../')
+
+config = {
+    'root': os.path.join(BASE_DIR, 'pages'),
+    'encoding': 'utf-8',
+    'extension': '.md',
+    'html_renderer': markdown,
+}
+
+logger = logging.getLogger(__name__)
+
+def discover_pages(app: Flask) -> List[dict]:
+    """
+    Walk the flatpage directory, finding, parsing, and
+    storing all pages in an index
+    """
+    page_index = {}
+    for current_path, _, file_list in os.walk(config['root']):
+        relative_path = current_path.replace(config['root'], '').lstrip(os.sep)
+
+        for name in file_list:
+            if not name.endswith(config['extension']):
+                continue
+
+            name_without_extension = os.path.splitext(name)[0]
+            full_path = os.path.join(relative_path, name_without_extension)
+
+            page = get_page(full_path)
+            page_index[full_path] = page
+
+            # If the file name is index, strip the name and add a pointer
+            # from the base directory to the full content.
+            if name_without_extension == 'index':
+                page_index[full_path.rsplit('/', 1)[0]] = page
+
+    app.page_index = page_index
+    return app
+
+def parse_page(content: str) -> dict:
+    """
+    Given the contents of a Markdown file, parse
+    the YAML config and HTML content
+    """
+    lines = iter(content.split('\n'))
+
+    # Read lines until we hit the empty line
+    meta = '\n'.join(takewhile(lambda l: l != '---', lines))
+    meta = yaml.safe_load(meta)
+    content = '\n'.join(lines)
+
+    # Render the Markdown content as HTML
+    html = markdown.markdown(content)
+
+    return dict(
+        **meta,
+        **{'html': html},
+    )
+
+def get_page(path: str, encoding: str=None) -> dict:
+    """
+    Accept a path in the vein of the blog, open it
+    within the filesystem, and parse its contents
+    """
+    logger.debug("Getting %s", path)
+    if encoding is None:
+        encoding = config['encoding']
+
+    path = os.path.join(config['root'], path + ".md")
+
+    with open(path, encoding=encoding) as file:
+        content = file.read()
+    return parse_page(content)
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,3 @@
+Flask==1.1.1
+Frozen-Flask==0.15
+Markdown==3.1.1
diff --git a/site.py b/site.py
@@ -0,0 +1,37 @@
+import sys
+
+from flask import Flask, abort, render_template
+from flask_frozen import Freezer
+
+from blog.flatpages import discover_pages
+
+app = Flask(__name__)
+freezer = Freezer(app)
+
+# Upon app load, we store all page content into memory. This is obviously
+# obscene but warrants itself sufficient at time of writing. If I ever
+# get around to writing more than a couple of things on here, I'll blow this
+# up into something more sane.
+discover_pages(app)
+
+@app.route('/')
+def index():
+    return render_template('index.html')
+
+@freezer.register_generator
+def pages():
+    for key in app.page_index.keys():
+        yield 'page', {'path': key}
+
+@app.route('/<path:path>/')
+def page(path):
+    p = app.page_index.get(path)
+    if not p:
+        abort(404)
+    return render_template('page.html', page=p)
+
+if __name__ == '__main__':
+    if len(sys.argv) > 1 and sys.argv[1] == "build":
+        freezer.freeze()
+    else:
+        app.run(port=4000, debug=True)
diff --git a/templates/base.html b/templates/base.html
@@ -0,0 +1,33 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset='utf-8'>
+    <title> Bartek Ciszkowski </title>
+<style type='text/css'>
+body {
+    margin: 1em 10em;
+    font-family: sans-serif;
+}
+
+h1 {
+    font-weight: 400;
+}
+
+h1 a { text-decoration: none; }
+h1 a:hover { text-decoration: underline; }
+
+p {
+    line-height: 1.4em;
+}
+
+li {
+    line-height: 1.4em;
+}
+</style>
+</head>
+<body>
+    {% block content %}
+    {% endblock content %}
+</body>
+</html>
+
diff --git a/templates/index.html b/templates/index.html
@@ -0,0 +1,39 @@
+{% extends "base.html" %}
+{% block content %}
+<h1><a href='{{ url_for("index") }}'>👋 Hello, I'm Bartek</a></h1>
+
+    <p>I'm a 30-something Polish dude raised mostly in Toronto, Canada, currently living
+    in Boston, Massachusetts. Apart from building software, I spend most of my
+    time being a loving father, cooking, travelling, and nerding out over
+    transportation systems.</p>
+
+    <h3>A little more about me</h3>
+
+    <p>I work at <a href='https://www.gadventures.com'>G Adventures</a>, a
+    sustainable tourism company working hard to make the world a better place.
+    I've been there longer than I ever anticipated, but the challenges keep
+    coming. Want to work with us? <a href='mailto:hello@justbartek.ca'>Talk to me</a>.</p>
+
+    <p>I'm currently reading Edward Snowden's <a href='https://en.wikipedia.org/wiki/Permanent_Record_(autobiography)'>Permanent Record</a></p>
+
+    <p>My current project revolves around improving the ability for
+    documentation to be discovered and connected within an organization. I hope
+    to have more to share soon.</p>
+
+    <p>My current travel ambitions are to see more of the United States, now
+    that I'm here (since September 2019)</p>
+
+    <p>You can also find me here:</p>
+
+    <ul>
+        <li><a href='https://github.com'>github/bartek</a></li>
+        <li><a href='https://twitter.com/bartekci'>twitter/bartekci</a></li>
+        <li><a href='https://stackoverflow.com/users/95509/bartek'>stack overflow</a></li>
+        <li><a href='https://familymeals.substack.com'>family meal night blog</a></li>
+    </ul>
+
+    <p>Although I have lingering profiles on Facebook and LinkedIn, I do not
+    actively use them, so please do not send me messages there.</p>
+
+    <p>Want to get in touch? <a href='mailto:hello@justbartek.ca'>Email</a> is best.</p>
+{% endblock %}
diff --git a/templates/page.html b/templates/page.html
@@ -0,0 +1,7 @@
+{% extends "base.html" %}
+
+{% block content %}
+    <h2>{{ page.title }}</h2>
+    <h3>{{ page.date }}</h3>
+    {{ page.html|safe }}
+{% endblock content %}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Flask==1.1.1`
	`2`	`+Frozen-Flask==0.15`
	`3`	`+Markdown==3.1.1`