runtimepy 5.15.5__tar.gz → 5.15.6__tar.gz

{runtimepy-5.15.5/runtimepy.egg-info → runtimepy-5.15.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.15.5
+Version: 5.15.6
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/libre-embedded/runtimepy
 Author: Libre Embedded
@@ -17,11 +17,11 @@ Classifier: Development Status :: 5 - Production/Stable
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: psutil
 Requires-Dist: aiofiles
 Requires-Dist: svgen>=0.8.0
-Requires-Dist: websockets
+Requires-Dist: psutil
 Requires-Dist: vcorelib>=3.6.4
+Requires-Dist: websockets
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -51,11 +51,11 @@ Dynamic: requires-python
     =====================================
     generator=datazen
     version=3.2.3
-    hash=fd0e57419cf9437a64c4f82cae3625f0
+    hash=0f8ffdbd46445346cb834d066f58e765
     =====================================
 -->
 
-# runtimepy ([5.15.5](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.15.6](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.15.5 → runtimepy-5.15.6}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.2.3
-    hash=fd0e57419cf9437a64c4f82cae3625f0
+    hash=0f8ffdbd46445346cb834d066f58e765
     =====================================
 -->
 
-# runtimepy ([5.15.5](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.15.6](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.15.5 → runtimepy-5.15.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "runtimepy"
-version = "5.15.5"
+version = "5.15.6"
 description = "A framework for implementing Python services."
 readme = "README.md"
 requires-python = ">=3.12"

{runtimepy-5.15.5 → runtimepy-5.15.6}/runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.2.3
-# hash=8ce7abe0f8c0e64d9afc0b5e4de6e2ad
+# hash=08c1dda8bd5fefe13af6a8eb49063498
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.15.5"
+VERSION = "5.15.6"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy-5.15.6/runtimepy/net/server/markdown.py

@@ -0,0 +1,101 @@
+"""
+A module implementing web server markdown interfaces.
+"""
+
+# built-in
+from io import StringIO
+import mimetypes
+from pathlib import Path
+from typing import Iterable, cast
+
+# third-party
+from svgen.element.html import div
+from vcorelib.io.file_writer import IndentedFileWriter
+from vcorelib.math.time import byte_count_str
+from vcorelib.paths import rel
+from vcorelib.paths import stats as _stats
+
+LOGO_MARKDOWN = "[![logo](/static/png/chip-circle-bootstrap/128x128.png)](/)"
+DIR_FILE = "dir.html"
+
+
+def file_preview(path: Path, link: Path) -> str:
+    """Get possible preview text for a file."""
+
+    preview = ""
+
+    if path.is_file():
+        mime, _ = mimetypes.guess_type(path, strict=False)
+        if mime and mime.startswith("image"):
+            preview = div(tag="img", src=f"/{link}", alt=str(link)).encode_str(
+                newlines=False
+            )
+
+    return preview
+
+
+def write_markdown_dir(
+    writer: IndentedFileWriter, path: Path, base: Path
+) -> None:
+    """Write markdown contents for a single directory."""
+
+    curr_dir = rel(path, base=base)
+
+    line = f"### `{base.name}/{curr_dir}`"
+
+    # Link to go up a directory.
+    if curr_dir != Path():
+        line += f" ([..](/{curr_dir.parent}/{DIR_FILE}))"
+
+    writer.write(line)
+    writer.empty()
+
+    writer.write("| name | size | preview |")
+    writer.write("|------|------|---------|")
+
+    for item in sorted(path.iterdir()):
+        curr = rel(item, base=base)
+
+        name = f"`{curr.name}`"
+        if item.is_dir():
+            name = f"**{name}**"
+
+        stats = _stats(item)
+        assert stats
+        size_str = byte_count_str(stats.st_size) if item.is_file() else ""
+
+        writer.write(
+            f"| [{name}](/{curr}) | {size_str} | {file_preview(item, curr)} |"
+        )
+
+    writer.empty()
+
+
+def markdown_for_dir(
+    paths_bases: Iterable[tuple[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():
+                if apps:
+                    writer.write(f"## {category}")
+                    with writer.padding():
+                        for app in apps:
+                            writer.write(f"* [{app}]({app})")
+
+        writer.write("## directories")
+        writer.empty()
+
+        for path, base in paths_bases:
+            write_markdown_dir(writer, path, base)
+
+        result: str = cast(StringIO, writer.stream).getvalue()
+
+    return result

{runtimepy-5.15.5 → runtimepy-5.15.6/runtimepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.15.5
+Version: 5.15.6
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/libre-embedded/runtimepy
 Author: Libre Embedded
@@ -17,11 +17,11 @@ Classifier: Development Status :: 5 - Production/Stable
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: psutil
 Requires-Dist: aiofiles
 Requires-Dist: svgen>=0.8.0
-Requires-Dist: websockets
+Requires-Dist: psutil
 Requires-Dist: vcorelib>=3.6.4
+Requires-Dist: websockets
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -51,11 +51,11 @@ Dynamic: requires-python
     =====================================
     generator=datazen
     version=3.2.3
-    hash=fd0e57419cf9437a64c4f82cae3625f0
+    hash=0f8ffdbd46445346cb834d066f58e765
     =====================================
 -->
 
-# runtimepy ([5.15.5](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.15.6](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

runtimepy-5.15.5/runtimepy/net/server/markdown.py

@@ -1,71 +0,0 @@
-"""
-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.math.time import byte_count_str
-from vcorelib.paths import rel
-from vcorelib.paths import stats as _stats
-
-LOGO_MARKDOWN = "[![logo](/static/png/chip-circle-bootstrap/128x128.png)](/)"
-DIR_FILE = "dir.html"
-
-
-def markdown_for_dir(
-    paths_bases: Iterable[tuple[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():
-                if apps:
-                    writer.write(f"## {category}")
-                    with writer.padding():
-                        for app in apps:
-                            writer.write(f"* [{app}]({app})")
-
-        writer.write("## directories")
-        writer.empty()
-
-        for path, base in paths_bases:
-            curr_dir = rel(path, base=base)
-            writer.write(f"### `{base.name}/{curr_dir}`")
-            writer.empty()
-
-            # Link to go up a directory.
-            if curr_dir != Path():
-                writer.write(f"* [..](/{curr_dir.parent}/{DIR_FILE})")
-
-            writer.write("| name | size |")
-            writer.write("|------|------|")
-            for item in sorted(path.iterdir()):
-                curr = rel(item, base=base)
-
-                name = f"`{curr.name}`"
-                if item.is_dir():
-                    name = f"**{name}**"
-
-                stats = _stats(item)
-                assert stats
-                size_str = (
-                    byte_count_str(stats.st_size) if item.is_file() else ""
-                )
-                writer.write(f"| [{name}](/{curr}) | {size_str} |")
-
-            writer.empty()
-
-        result: str = cast(StringIO, writer.stream).getvalue()
-
-    return result