runtimepy 5.10.1__py3-none-any.whl → 5.10.2__py3-none-any.whl

runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=649474f8a3122bccd6febc4bb2156b11
+# hash=9114f245a523f60ffbbfdd040548fc7c
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.10.1"
+VERSION = "5.10.2"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy/data/static/svg/chip-circle-bootstrap.svg

@@ -1,5 +1,5 @@
 <svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">
-  <circle r="50.0" cx="50.0" cy="50.0" style="fill: #ADB5BD" />
+  <circle r="50.0" cx="50.0" cy="50.0" style="fill: #6C757D" />
   <rect x="16.666666666666664" y="33.333333333333336" width="16.666666666666668" height="8.333333333333334" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
   <rect x="16.666666666666664" y="45.833333333333336" width="16.666666666666668" height="8.333333333333334" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
   <rect x="16.666666666666664" y="58.333333333333336" width="16.666666666666668" height="8.333333333333334" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />

runtimepy/net/server/__init__.py

@@ -24,6 +24,7 @@ from runtimepy.net.http.request_target import PathMaybeQuery
 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
 
@@ -177,10 +178,20 @@ class RuntimepyServerConnection(HttpConnection):
 
         result = None
 
-        # Try serving the path as a file.
+        # Keep track of directories encountered.
+        directories: list[Path] = []
+
+        # Build a list of all candidate files to check.
+        candidates: list[Path] = []
         for search in self.paths:
             candidate = search.joinpath(path[0][1:])
+            if candidate.is_dir():
+                directories.append(candidate)
+                candidates.append(candidate.joinpath("index.html"))
+            else:
+                candidates.append(candidate)
 
+        for candidate in candidates:
             # Handle markdown sources.
             if candidate.name:
                 md_candidate = candidate.with_suffix(".md")
@@ -189,6 +200,7 @@ class RuntimepyServerConnection(HttpConnection):
                         md_candidate, response, path[1]
                     )
 
+            # Handle files.
             if candidate.is_file():
                 mime, encoding = mimetypes.guess_type(candidate, strict=False)
 
@@ -203,9 +215,18 @@ class RuntimepyServerConnection(HttpConnection):
 
                 # Return the file data.
                 result = await read_binary(candidate)
-
                 break
 
+        # Handle a directory as a last resort.
+        if not result and directories:
+            result = self.render_markdown(
+                markdown_for_dir(
+                    directories[0], {"applications": self.apps.keys()}
+                ),
+                response,
+                path[1],
+            )
+
         return result
 
     def handle_command(
@@ -278,7 +299,7 @@ class RuntimepyServerConnection(HttpConnection):
                     return self.favicon_data
 
                 # Try serving a file and handling redirects.
-                for handler in [self.try_file, self.try_redirect]:
+                for handler in [self.try_redirect, self.try_file]:
                     result = await handler(
                         request.target.origin_form, response
                     )

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

{runtimepy-5.10.1.dist-info → runtimepy-5.10.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.10.1
+Version: 5.10.2
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -17,11 +17,11 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: psutil
 Requires-Dist: websockets
+Requires-Dist: aiofiles
 Requires-Dist: vcorelib>=3.5.1
 Requires-Dist: svgen>=0.7.4
-Requires-Dist: psutil
-Requires-Dist: aiofiles
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -42,6 +42,7 @@ Requires-Dist: types-setuptools; extra == "test"
 Requires-Dist: uvloop; (sys_platform != "win32" and sys_platform != "cygwin") and extra == "test"
 Dynamic: author
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 
@@ -49,11 +50,11 @@ Dynamic: requires-python
     =====================================
     generator=datazen
     version=3.1.4
-    hash=a8fb82d7f11d94c5c3ad4adea1026d9e
+    hash=887650b5b88ff596b3ab067e01de6fbd
     =====================================
 -->
 
-# runtimepy ([5.10.1](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.10.2](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/vkottler/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.10.1.dist-info → runtimepy-5.10.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-runtimepy/__init__.py,sha256=uZ2pA4H_IPEEbU0jsR1ZRf1g4gyxUbUuexk35KLNE3g,391
+runtimepy/__init__.py,sha256=UgkSoIgawdI6UkjuTTg7IIFglX0-IDgjuWRujjVjW_s,391
 runtimepy/__main__.py,sha256=OPAed6hggoQdw-6QAR62mqLC-rCkdDhOq0wyeS2vDRI,332
 runtimepy/app.py,sha256=sTvatbsGZ2Hdel36Si_WUbNMtg9CzsJyExr5xjIcxDE,970
 runtimepy/dev_requirements.txt,sha256=j0dh11ztJAzfaUL0iFheGjaZj9ppDzmTkclTT8YKO8c,230
@@ -45,7 +45,7 @@ runtimepy/data/404.html,sha256=sn0Mcntzb1-AekukYZAQqz43xfmZtTWa2n2HD2ItqDM,4697
 runtimepy/data/browser.yaml,sha256=oc5KEV1C1uAJ4MkhNo4hyVVfJtZvHelRNqzNvD313Ow,79
 runtimepy/data/dummy_load.yaml,sha256=PfKRXXgZnENRMSd68eznSMTV8xanVH5JY4FmoZRPFGY,1985
 runtimepy/data/factories.yaml,sha256=esuoouMre8w7siZfBoZKqC-5myghJ_WwOOCDIq135zg,1899
-runtimepy/data/favicon.ico,sha256=iPOtqnqrFVr5tNBM6kTsw7nh0KullEz4TpS6CEQ2HVM,362870
+runtimepy/data/favicon.ico,sha256=boxAGaHbUjMFrOO2TZpsO0nIRC-LUgwHVQYOiG1YQnM,362870
 runtimepy/data/sample_telemetry.yaml,sha256=OpdFurkvtWJGaNl9LMlU2rKo15AaVVr-U_hoZfsbp-Y,695
 runtimepy/data/server.yaml,sha256=wS_Ceiu2TpkfPurpqoYoPlgzc9DAWtUd24MW7t-S5rU,97
 runtimepy/data/server_base.yaml,sha256=R_varVgGPGV4nxWYYwKUnHC9ufINi4V92YVhxCCC5wg,875
@@ -107,7 +107,7 @@ runtimepy/data/schemas/has_factory.yaml,sha256=Rsqrxv3HEBUGxPcW6CN7QczA96iBSgtm0
 runtimepy/data/schemas/has_markdown.yaml,sha256=LbnEQRYdk5KR_GgORmIOiKjRg-HF8wjhA6Dm6pSm66I,45
 runtimepy/data/schemas/has_name.yaml,sha256=I5YkXxQRYz-1-49CLyr_NA2zVqyRVQCAsb-icTaxF4s,59
 runtimepy/data/schemas/has_request_flag.yaml,sha256=S8ly8g-FkrCVNEizbXPqicg_hpGvtH7WRsHZAA4uhjc,66
-runtimepy/data/static/svg/chip-circle-bootstrap.svg,sha256=cGCiwiVWoO39vzdAt683Fk3W42XE6-RGT0QZtsDAv4o,3124
+runtimepy/data/static/svg/chip-circle-bootstrap.svg,sha256=uwo45eymlKmV3AOQ217Etarjb0UBzJJNFLa8JgQx86Y,3124
 runtimepy/data/static/woff2/CascadiaCode-Bold.woff2,sha256=vnrwH_YbbVnq0_aedSECg-eieky43TOK3MxtCWIc_Ug,154520
 runtimepy/data/static/woff2/CascadiaCode-BoldItalic.woff2,sha256=OOWBMRXRJJKxEfEIlKKnT-tFqoZKqGw5hMa69t-gp1c,113236
 runtimepy/data/static/woff2/CascadiaCode-Italic.woff2,sha256=RbBc8ehMSl_ixGWnEe7zn841xDsyxdDJTo3rkYY-bf8,111628
@@ -178,9 +178,10 @@ runtimepy/net/http/request_target.py,sha256=EE1aI5VSARw1h93jyZvP56ir5O5fjd6orYK-
 runtimepy/net/http/response.py,sha256=Sup8W_A0ADNzR5olKrQsVNhsQXUwPOD-eJLlLOgYlAY,2316
 runtimepy/net/http/state.py,sha256=qCMN8aWfCRfU9XP-cIhSOo2RqfljTjbQRCflfcy2bfY,1626
 runtimepy/net/http/version.py,sha256=mp6rgIM7-VUVKLCA0Uw96CmBkL0ET860lDVVEewpZ7w,1098
-runtimepy/net/server/__init__.py,sha256=Kg1NenLXSDWYa7NFvQLu2hHU4p6sYXwspv2NSZ7VfSo,9647
+runtimepy/net/server/__init__.py,sha256=RojwvQgqc0rTl36rXDSiM56tVXtD15T5OkpuJanlNjY,10438
 runtimepy/net/server/html.py,sha256=ufg0PQF_iUE7PT0n3Pn3jTcun7mspZUI6_ooblcNnvI,1217
 runtimepy/net/server/json.py,sha256=a7vM5yfq2er4DexzFqEMnxoMGDeuywKkVH4-uNJBAik,2522
+runtimepy/net/server/markdown.py,sha256=DFjGbvIST4HXRhtTTvXVQ9ZAwrIfVzPlcU1dW8JYya8,1381
 runtimepy/net/server/app/__init__.py,sha256=beU67t7zoKGlO7aldjQMUwYLm9mSlc78eMQazri-otw,3012
 runtimepy/net/server/app/base.py,sha256=HF_Qa3ufrZNaYBVnBwGi-Siv3nneqEo01j5h5pK-ZTk,1871
 runtimepy/net/server/app/create.py,sha256=eRT8qxubht5A7149Xol3Z8rkdYd_pjNLqrlyMnXk-Zg,2660
@@ -284,9 +285,9 @@ runtimepy/tui/task.py,sha256=nUZo9fuOC-k1Wpqdzkv9v1tQirCI28fZVgcC13Ijvus,1093
 runtimepy/tui/channels/__init__.py,sha256=evDaiIn-YS9uGhdo8ZGtP9VK1ek6sr_P1nJ9JuSET0o,4536
 runtimepy/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runtimepy/ui/controls.py,sha256=yvT7h3thbYaitsakcIAJ90EwKzJ4b-jnc6p3UuVf_XE,1241
-runtimepy-5.10.1.dist-info/LICENSE,sha256=yKBRwbO-cOPBrlpsZmJkkSa33DfY31aE8t7lZ0DwlUo,1071
-runtimepy-5.10.1.dist-info/METADATA,sha256=XmFGbIXFW_oILfJuI2DX6HoAxjr92SGzxX07oiUJx1c,9373
-runtimepy-5.10.1.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-runtimepy-5.10.1.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
-runtimepy-5.10.1.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
-runtimepy-5.10.1.dist-info/RECORD,,
+runtimepy-5.10.2.dist-info/licenses/LICENSE,sha256=yKBRwbO-cOPBrlpsZmJkkSa33DfY31aE8t7lZ0DwlUo,1071
+runtimepy-5.10.2.dist-info/METADATA,sha256=IOAwfPX8fSot0nOILOJsicLv4Go7fAl6DBQYl7qj-rQ,9395
+runtimepy-5.10.2.dist-info/WHEEL,sha256=DK49LOLCYiurdXXOXwGJm6U4DkHkg4lcxjhqwRa0CP4,91
+runtimepy-5.10.2.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
+runtimepy-5.10.2.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
+runtimepy-5.10.2.dist-info/RECORD,,

{runtimepy-5.10.1.dist-info → runtimepy-5.10.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (78.0.2)
 Root-Is-Purelib: true
 Tag: py3-none-any