Render markdown for directories

Author: vkottler

runtimepy/net/server/__init__.py

@@ -24,6 +24,7 @@
 from runtimepy.net.http.response import ResponseHeader
 from runtimepy.net.server.html import HtmlApp, HtmlApps, get_html, html_handler
 from runtimepy.net.server.json import encode_json, json_handler
+from runtimepy.net.server.markdown import markdown_for_dir
 from runtimepy.net.tcp.http import HttpConnection
 from runtimepy.util import normalize_root, path_has_part, read_binary
 
@@ -189,6 +190,7 @@ async def try_file(
                         md_candidate, response, path[1]
                     )
 
+            # Handle files.
             if candidate.is_file():
                 mime, encoding = mimetypes.guess_type(candidate, strict=False)
 
@@ -203,7 +205,17 @@ async def try_file(
 
                 # Return the file data.
                 result = await read_binary(candidate)
+                break
 
+            # Handle directories.
+            if candidate.is_dir():
+                result = self.render_markdown(
+                    markdown_for_dir(
+                        candidate, {"applications": self.apps.keys()}
+                    ),
+                    response,
+                    path[1],
+                )
                 break
 
         return result

runtimepy/net/server/markdown.py

@@ -0,0 +1,53 @@
+"""
+A module implementing web server markdown interfaces.
+"""
+
+# built-in
+from io import StringIO
+from pathlib import Path
+from typing import Iterable, cast
+
+# third-party
+from vcorelib.io.file_writer import IndentedFileWriter
+from vcorelib.paths import rel
+
+LOGO_MARKDOWN = (
+    "[![logo](https://libre-embedded.com/static/"
+    "png/chip-circle-bootstrap/128x128.png)](https://libre-embedded.com)"
+)
+
+
+def markdown_for_dir(
+    path: Path, extra_links: dict[str, Iterable[str]] = None
+) -> str:
+    """Get markdown data for a directory."""
+
+    with IndentedFileWriter.string() as writer:
+        writer.write(f"# Directory {LOGO_MARKDOWN} Viewer")
+        with writer.padding():
+            writer.write("---")
+
+        if extra_links:
+            for category, apps in extra_links.items():
+                writer.write(f"## {category}")
+                with writer.padding():
+                    for app in apps:
+                        writer.write(f"* [{app}]({app})")
+
+        writer.write(f"## `{path}`")
+        writer.empty()
+
+        writer.write("* [..](..)")
+
+        for item in path.iterdir():
+            curr = rel(item, base=path)
+
+            name = f"`{curr}`"
+            if item.is_dir():
+                name = f"**{name}**"
+
+            writer.write(f"* [{name}]({curr})")
+
+        result: str = cast(StringIO, writer.stream).getvalue()
+
+    return result