runtimepy 5.13.0__tar.gz → 5.13.2__tar.gz

{runtimepy-5.13.0/runtimepy.egg-info → runtimepy-5.13.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.13.0
+Version: 5.13.2
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/libre-embedded/runtimepy
 Author: Libre Embedded
@@ -17,10 +17,10 @@ Classifier: Development Status :: 5 - Production/Stable
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: vcorelib>=3.5.8
 Requires-Dist: psutil
+Requires-Dist: svgen>=0.7.12
 Requires-Dist: aiofiles
-Requires-Dist: vcorelib>=3.5.1
-Requires-Dist: svgen>=0.7.4
 Requires-Dist: websockets
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
@@ -50,12 +50,12 @@ Dynamic: requires-python
 <!--
     =====================================
     generator=datazen
-    version=3.2.1
-    hash=4f0e82dc45d3ea9c4ccf5b262413c206
+    version=3.2.3
+    hash=f3bcab8765e649f1b80ad504e5debde9
     =====================================
 -->
 
-# runtimepy ([5.13.0](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.13.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/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.13.0 → runtimepy-5.13.2}/README.md

@@ -1,12 +1,12 @@
 <!--
     =====================================
     generator=datazen
-    version=3.2.1
-    hash=4f0e82dc45d3ea9c4ccf5b262413c206
+    version=3.2.3
+    hash=f3bcab8765e649f1b80ad504e5debde9
     =====================================
 -->
 
-# runtimepy ([5.13.0](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.13.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/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.13.0 → runtimepy-5.13.2}/pyproject.toml

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

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
-# hash=35e5555173fdfd064e5047172de9b6a4
+# version=3.2.3
+# hash=6693eae62108cbcdfbccdb9de6b57fa8
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.13.0"
+VERSION = "5.13.2"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/__main__.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=b28a8111bcc727e854c1f6474a3c4232
 # =====================================
 """

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/app.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=a4deafb4ebcc179d8d85f9376d22dc92
 # =====================================
 

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/commands/all.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=1814b7f7fae3556a0dbeec37141e4182
 # =====================================
 

runtimepy-5.13.2/runtimepy/data/base.yaml

@@ -0,0 +1,19 @@
+---
+includes:
+  - package://runtimepy/factories.yaml
+
+init:
+  - runtimepy.net.arbiter.housekeeping.init
+
+config:
+  # Default redirects.
+  http_redirects:
+    "/": "/index.html"
+    "/index.html": "/app.html"
+
+  # Serve these applications by default at these paths.
+  http_app_paths: ["/app.html"]
+
+# Handles config["http_app_prefixes"].
+config_builders:
+  - runtimepy.net.html.arbiter.web_app_paths

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/data/css/main.css

@@ -52,6 +52,6 @@ body > :first-child {
   border-right: var(--bs-border-width) var(--bs-border-style) var(--bs-link-hover-color) !important;
 }
 
-canvas:focus {
+:focus {
   outline: none;
 }

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/data/server_base.yaml

@@ -1,6 +1,6 @@
 ---
 includes:
-  - package://runtimepy/factories.yaml
+  - package://runtimepy/base.yaml
 
 ports:
   - {name: runtimepy_http_server, type: tcp}
@@ -10,22 +10,6 @@ ports:
 structs:
   - {name: ui, factory: ui_state}
 
-init:
-  - runtimepy.net.arbiter.housekeeping.init
-
-config:
-  # Default redirects.
-  http_redirects:
-    "/": "/index.html"
-    "/index.html": "/app.html"
-
-  # Serve these applications by default at these paths.
-  http_app_paths: ["/app.html"]
-
-# Handles config["http_app_prefixes"].
-config_builders:
-  - runtimepy.net.html.arbiter.web_app_paths
-
 servers:
   - factory: runtimepy_http
     kwargs: {port: "$runtimepy_http_server"}

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/entry.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=79c31d1280a6e97b5d326aecb758c597
 # =====================================
 

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/net/html/__init__.py

@@ -51,9 +51,10 @@ def create_app_shell(
     # Dark/light theme switch button.
     bootstrap_button(
         icon_str("lightbulb"),
-        tooltip=" Toggle light/dark.",
+        tooltip="Toggle light/dark.",
         id="theme-button",
         parent=button_column,
+        title="change theme button",
     )
 
     return container, button_column
@@ -112,6 +113,7 @@ def full_markdown_page(
         icon_str("printer"),
         tooltip="Printer-friendly view.",
         id="print-button",
+        title="print-view button",
         parent=div(tag="a", href="?print=true", parent=button_column),
     )
 

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/net/server/__init__.py

@@ -55,6 +55,12 @@ class RuntimepyServerConnection(HttpConnection):
     class_paths: list[Pathlike] = [Path(), package_data_dir()]
     class_redirect_paths: dict[Path, Union[str, Path]] = {}
 
+    # Set these to control meta attributes.
+    metadata: dict[str, Optional[str]] = {
+        "title": HttpConnection.identity,
+        "description": None,
+    }
+
     def add_path(self, path: Pathlike, front: bool = False) -> None:
         """Add a path."""
 
@@ -145,7 +151,16 @@ class RuntimepyServerConnection(HttpConnection):
     ) -> bytes:
         """Return rendered markdown content."""
 
-        document = get_html()
+        meta: dict[str, str] = type(self).metadata.copy()  # type: ignore
+
+        meta.setdefault("description", "")
+        meta["description"] += (
+            " This page was rendered from "
+            f"Markdown by {HttpConnection.identity}."
+        )
+
+        document = get_html(**meta)
+
         with IndentedFileWriter.string() as writer:
             writer.write_markdown(content, **kwargs)
             full_markdown_page(
@@ -156,7 +171,9 @@ class RuntimepyServerConnection(HttpConnection):
 
         response["Content-Type"] = f"text/html; charset={DEFAULT_ENCODING}"
 
-        return document.encode_str().encode()
+        with StringIO() as stream:
+            document.render(stream)
+            return stream.getvalue().encode()
 
     async def render_markdown_file(
         self,
@@ -179,14 +196,14 @@ class RuntimepyServerConnection(HttpConnection):
         result: HttpResult = None
 
         # Keep track of directories encountered.
-        directories: list[Path] = []
+        directories: list[tuple[Path, 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)
+                directories.append((candidate, search))
                 candidates.append(candidate.joinpath("index.html"))
             else:
                 candidates.append(candidate)
@@ -206,6 +223,13 @@ class RuntimepyServerConnection(HttpConnection):
 
                 # Set MIME type if it can be determined.
                 if mime:
+                    # webhint suggestion
+                    if (
+                        mime.startswith("text")
+                        and DEFAULT_ENCODING not in mime
+                    ):
+                        mime += f"; charset={DEFAULT_ENCODING}"
+
                     response["Content-Type"] = mime
 
                 # We don't handle this yet.
@@ -219,9 +243,10 @@ class RuntimepyServerConnection(HttpConnection):
 
         # Handle a directory as a last resort.
         if not result and directories:
+            candidate, search = directories[0]
             result = self.render_markdown(
                 markdown_for_dir(
-                    directories[0], {"applications": self.apps.keys()}
+                    candidate, search, {"applications": self.apps.keys()}
                 ),
                 response,
                 path[1],
@@ -326,6 +351,7 @@ class RuntimepyServerConnection(HttpConnection):
                         response,
                         request_data,
                         default_app=type(self).default_app,
+                        **type(self).metadata,
                     )
 
                 if populated:

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/net/server/app/__init__.py

@@ -68,6 +68,8 @@ async def setup(app: AppInfo) -> int:
         )
     )
 
+    RuntimepyServerConnection.metadata.update(app.config_param("html", {}))
+
     # Default application (environment tabs).
     html_app = create_app(app, getattr(_import_module(module), method))
     target: str

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/net/server/app/env/tab/html.py

@@ -226,6 +226,7 @@ class ChannelEnvironmentTabHtml(ChannelEnvironmentTabControls):
         vert_container = flex(
             parent=container,
             kind="column",
+            tag="form",
         )
         vert_container.add_class("channel-column", "collapse", "show")
 

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/net/server/app/env/widgets.py

@@ -110,6 +110,7 @@ def channel_table_header(
         tooltip="Clear plotted channels.",
         icon="x-lg",
         id="clear-plotted-channels",
+        title="button for clearing plotted channels",
     ).add_class("pb-2")
 
     input_box(
@@ -124,6 +125,7 @@ def channel_table_header(
         icon="trash",
         tooltip="Clear all plot points.",
         id="clear-plotted-points",
+        title="button for clearing plot point data",
     ).add_class("pb-2")
 
     cell = flex(tag="th", parent=ctl_row)

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/net/server/html.py

@@ -6,6 +6,7 @@ A module implementing HTML interfaces for web applications.
 from typing import Awaitable, Callable, Optional, TextIO
 
 # third-party
+from svgen.element import Element
 from svgen.element.html import Html
 from vcorelib import DEFAULT_ENCODING
 
@@ -20,10 +21,36 @@ HtmlApp = Callable[
 HtmlApps = dict[str, HtmlApp]
 
 
-def get_html() -> Html:
+def get_html(
+    title: str = HttpConnection.identity,
+    cache_control: str = "public",
+    description: str = None,
+    **kwargs,
+) -> Html:
     """Get a default HTML document."""
 
-    return Html(HttpConnection.identity)
+    elem = Html(title, **kwargs)
+
+    elem.head.children.append(
+        Element(
+            tag="meta",
+            attrib={"http-equiv": "Cache-Control", "content": cache_control},
+        )
+    )
+
+    elem.head.children.append(
+        Element(tag="link", rel="icon", href="/favicon.ico")
+    )
+
+    if description:
+        elem.head.children.append(
+            Element(
+                tag="meta",
+                attrib={"name": "description", "content": description},
+            )
+        )
+
+    return elem
 
 
 async def html_handler(
@@ -33,6 +60,7 @@ async def html_handler(
     response: ResponseHeader,
     request_data: Optional[bytes],
     default_app: HtmlApp = None,
+    **kwargs,
 ) -> bool:
     """Render an HTML document in response to an HTTP request."""
 
@@ -42,6 +70,8 @@ async def html_handler(
     # Create the application.
     app = apps.get(request.target.path, default_app)
     if app is not None:
-        (await app(get_html(), request, response, request_data)).render(stream)
+        (
+            await app(get_html(**kwargs), request, response, request_data)
+        ).render(stream)
 
     return app is not None

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/net/server/markdown.py

@@ -11,14 +11,11 @@ from typing import Iterable, cast
 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)"
-)
+LOGO_MARKDOWN = "[![logo](/static/png/chip-circle-bootstrap/128x128.png)](/)"
 
 
 def markdown_for_dir(
-    path: Path, extra_links: dict[str, Iterable[str]] = None
+    path: Path, base: Path, extra_links: dict[str, Iterable[str]] = None
 ) -> str:
     """Get markdown data for a directory."""
 
@@ -29,24 +26,28 @@ def markdown_for_dir(
 
         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}`")
+                if apps:
+                    writer.write(f"## {category}")
+                    with writer.padding():
+                        for app in apps:
+                            writer.write(f"* [{app}]({app})")
+
+        curr_dir = rel(path, base=base)
+        writer.write(f"## `{curr_dir}`")
         writer.empty()
 
-        writer.write("* [..](..)")
+        # Link to go up a directory.
+        if curr_dir != Path():
+            writer.write(f"* [..](/{curr_dir.parent})")
 
         for item in path.iterdir():
-            curr = rel(item, base=path)
+            curr = rel(item, base=base)
 
-            name = f"`{curr}`"
+            name = f"`{curr.name}`"
             if item.is_dir():
                 name = f"**{name}**"
 
-            writer.write(f"* [{name}]({curr})")
+            writer.write(f"* [{name}](/{curr})")
 
         result: str = cast(StringIO, writer.stream).getvalue()
 

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/net/tcp/http/__init__.py

@@ -52,10 +52,13 @@ def to_json(response: HttpResponse) -> Any:
     )
 
 
+IDENTITY = f"{PKG_NAME}/{VERSION}"
+
+
 class HttpConnection(_TcpConnection):
     """A class implementing a basic HTTP interface."""
 
-    identity = f"{PKG_NAME}/{VERSION}"
+    identity = IDENTITY
 
     expecting_response: bool
 
@@ -126,7 +129,11 @@ class HttpConnection(_TcpConnection):
             )
 
         # Set boilerplate header data.
-        response["server"] = self.identity
+
+        # webhint suggestions
+        # response["server"] = self.identity
+        response["server"] = PKG_NAME
+        response["X-Content-Type-Options"] = "nosniff"
 
         return result
 

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy/requirements.txt

@@ -1,6 +1,6 @@
 aiofiles
-vcorelib>=3.5.1
-svgen>=0.7.4
+vcorelib>=3.5.8
+svgen>=0.7.12
 websockets
 psutil
 windows-curses; sys_platform == 'win32' and python_version < '3.12'

{runtimepy-5.13.0 → runtimepy-5.13.2/runtimepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.13.0
+Version: 5.13.2
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/libre-embedded/runtimepy
 Author: Libre Embedded
@@ -17,10 +17,10 @@ Classifier: Development Status :: 5 - Production/Stable
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: vcorelib>=3.5.8
 Requires-Dist: psutil
+Requires-Dist: svgen>=0.7.12
 Requires-Dist: aiofiles
-Requires-Dist: vcorelib>=3.5.1
-Requires-Dist: svgen>=0.7.4
 Requires-Dist: websockets
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
@@ -50,12 +50,12 @@ Dynamic: requires-python
 <!--
     =====================================
     generator=datazen
-    version=3.2.1
-    hash=4f0e82dc45d3ea9c4ccf5b262413c206
+    version=3.2.3
+    hash=f3bcab8765e649f1b80ad504e5debde9
     =====================================
 -->
 
-# runtimepy ([5.13.0](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.13.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/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy.egg-info/SOURCES.txt

@@ -52,6 +52,7 @@ runtimepy/control/source.py
 runtimepy/control/step.py
 runtimepy/control/env/__init__.py
 runtimepy/data/404.html
+runtimepy/data/base.yaml
 runtimepy/data/browser.yaml
 runtimepy/data/dummy_load.yaml
 runtimepy/data/factories.yaml

{runtimepy-5.13.0 → runtimepy-5.13.2}/runtimepy.egg-info/requires.txt

@@ -1,7 +1,7 @@
+vcorelib>=3.5.8
 psutil
+svgen>=0.7.12
 aiofiles
-vcorelib>=3.5.1
-svgen>=0.7.4
 websockets
 
 [test]

{runtimepy-5.13.0 → runtimepy-5.13.2}/setup.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=23791ff25e92caf639fdcfe48ce010bf
 # =====================================