change sample to hello, and address other feedback

Author: Mike Prosser

CONTRIBUTING.md

@@ -57,11 +57,12 @@ start docs\_build\index.html
 ## Running examples
 
 1. First, run the PythonPanelService (not part of this repo, provided seperately)
-2. Run the command `poetry run python examples/sample/sample.py`
-3. Open http://localhost:42001/panel-service/panels/sample_panel/ in your browser
+2. Run the command `poetry run python examples/hello/hello.py`
+3. Open http://localhost:42001/panel-service/panels/hello_panel/ in your browser
 4. If there is an error about missing imports (especially nipanel), execute this
-   command to install the dependencies into the venv: `C:\Users\mprosser\AppData\Local\Temp\python_panel_service_venv\Scripts\python.exe
-   -m pip install C:\dev\fireserp\nipanel-python[examples,dev]`, then restart the PythonPanelService and re-run sample.py.
+   command (from the nipanel-python directory) to install the dependencies into the venv: 
+   `%localappdata%\Temp\python_panel_service_venv\Scripts\python.exe -m pip install .\[examples,dev]`,
+    then restart the PythonPanelService and re-run hello.py.
 
 You can see all running panels (and stop them) at: http://localhost:42001/panel-service/
 

examples/hello/README.md

@@ -0,0 +1,15 @@
+## Hello
+
+This is a simple nipanel example that displays a Streamlit app.
+
+### Feature
+
+- Just a Hello World
+
+### Required Software
+
+- Python 3.9 or later
+
+### Usage
+
+Run `poetry run python examples/hello/hello.py`

examples/hello/hello.py

@@ -0,0 +1,12 @@
+"""This example demonstrates how to open/update a Streamlit application using nipanel package."""
+
+from pathlib import Path
+
+import nipanel
+
+panel_script_path = Path(__file__).with_name("hello_panel.py")
+panel = nipanel.create_panel(panel_script_path)
+
+panel.set_value("hello_string", "Hello, World!")
+
+print(f"Panel URL: {panel.panel_url}")

examples/hello/hello_panel.py

@@ -0,0 +1,11 @@
+"""A Streamlit visualization panel for the hello.py example script."""
+
+import streamlit as st
+
+import nipanel
+
+panel = nipanel.get_panel_accessor()
+
+st.set_page_config(page_title="Hello World Example", page_icon="📊", layout="wide")
+st.title("Hello World Example")
+st.write(panel.get_value("hello_string", ""))

examples/sample/README.md

@@ -1,4 +1,4 @@
-"""Example of displaying a sine wave using streamlit-echarts in a nipanel."""
+"""A Streamlit visualization panel for the simple_graph.py example script."""
 
 import streamlit as st
 from streamlit_echarts import st_echarts  # type: ignore

examples/sample/sample.py

@@ -32,13 +32,13 @@ def create_panel(streamlit_script_path: Path) -> StreamlitPanel:
             "nipanel.create_panel() should not be called from a Streamlit script. Call nipanel.get_panel_accessor() instead."
         )
 
-    path_str = str(streamlit_script_path)
-    if not path_str.endswith(".py"):
+    if streamlit_script_path.suffix != ".py":
         raise ValueError(
             "The provided script path must be a valid Streamlit script ending with '.py'."
         )
 
     panel_id = streamlit_script_path.stem
+    path_str = str(streamlit_script_path)
     return StreamlitPanel(panel_id, path_str)
 
 

examples/sample/sample_panel.py

@@ -1,5 +1,7 @@
 """Classes to convert between measurement specific protobuf types and containers."""
 
+from __future__ import annotations
+
 import collections.abc
 import datetime as dt
 from typing import Type, Union
@@ -100,7 +102,7 @@ def _value_to_attribute(self, value: ExtendedPropertyValue) -> WaveformAttribute
     def to_python_value(self, protobuf_message: DoubleAnalogWaveform) -> AnalogWaveform[np.float64]:
         """Convert the protobuf DoubleAnalogWaveform to a Python AnalogWaveform."""
         # Declare timing to accept both bintime and dt.datetime to satisfy mypy.
-        timing: Timing[Union[bt.DateTime, dt.datetime]]
+        timing: Timing[bt.DateTime | dt.datetime]
         if not protobuf_message.dt and not protobuf_message.HasField("t0"):
             # If both dt and t0 are unset, use Timing.empty.
             timing = Timing.empty