Merge branch 'main' of https://github.com/ni/nipanel-python

Author: Dilmi Wickramanayake

.github/renovate.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "branchPrefix": "users/renovate/",
+  "timezone": "US/Central",
+  "extends": [
+    "config:recommended",
+    "helpers:pinGitHubActionDigestsToSemver",
+    ":enableVulnerabilityAlerts"
+  ],
+  "packageRules": [
+    {
+      // Update GitHub Actions on weekends.
+      "matchCategories": ["github-actions"],
+      "groupName": "GitHub Actions",
+      "groupSlug": "github",
+      "schedule": [
+        "* * * * 0,6"
+      ]
+    },
+    {
+      // Update Python packages on weekends, separate from lockFileMaintenance.
+      "matchCategories": ["python"],
+      "matchUpdateTypes": ["major", "minor", "patch", "rollback", "replacement"],
+      "groupName": "Python packages",
+      "groupSlug": "python",
+      "schedule": [
+        "* * * * 0,6"
+      ]
+    }
+  ],
+  "lockFileMaintenance": {
+    // Maintain lock files on early Tuesday mornings. This is primarily to
+    // update indirect dependencies that aren't handled by the Python packages
+    // group.
+    "enabled": true,
+    "schedule": [
+      "* 0-3 * * 2"
+    ]
+  },
+  "osvVulnerabilityAlerts": true
+}

.github/renovate.json5

@@ -54,6 +54,18 @@ poetry run sphinx-build docs docs/_build --builder html --fail-on-warning
 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/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 (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/
+
 # Debugging on the streamlit side
 
 Debugging the measurement script can be done using standard Python debugging

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+## All Types Example
+
+This is an example for `nipanel` that demonstrates all supported data types
+
+### Feature
+
+- Demonstrates support for all data types
+
+### Required Software
+
+- Python 3.9 or later
+
+### Usage
+
+Run `poetry run python examples/all_types/all_types.py`

examples/all_types/README.md

@@ -0,0 +1,23 @@
+"""An example that demonstrates the supported data types for nipanel scripts."""
+
+from pathlib import Path
+
+from define_types import all_types_with_values
+
+import nipanel
+
+panel_script_path = Path(__file__).with_name("all_types_panel.py")
+panel = nipanel.create_panel(panel_script_path)
+
+print("Setting values")
+for name, value in all_types_with_values.items():
+    print(f"{name:>15}   {value}")
+    panel.set_value(name, value)
+
+print()
+print("Getting values")
+for name in all_types_with_values.keys():
+    the_value = panel.get_value(name)
+    print(f"{name:>20}   {the_value}")
+
+print(f"Panel URL: {panel.panel_url}")

examples/all_types/all_types.py

@@ -0,0 +1,20 @@
+"""A Streamlit visualization panel for the all_types.py example script."""
+
+import streamlit as st
+from define_types import all_types_with_values
+
+import nipanel
+
+panel = nipanel.get_panel_accessor()
+
+st.set_page_config(page_title="All Types Example", page_icon="📊", layout="wide")
+st.title("All Types Example")
+
+for name in all_types_with_values.keys():
+    col1, col2 = st.columns([0.4, 0.6])
+
+    with col1:
+        st.write(name)
+
+    with col2:
+        st.write(panel.get_value(name))

examples/all_types/all_types_panel.py

@@ -0,0 +1,62 @@
+"""Define types."""
+
+import enum
+
+import numpy as np
+from nitypes.scalar import Scalar
+from nitypes.waveform import AnalogWaveform
+
+
+class MyIntFlags(enum.IntFlag):
+    """Example of an IntFlag enum."""
+
+    VALUE1 = 1
+    VALUE2 = 2
+    VALUE4 = 4
+
+
+class MyIntEnum(enum.IntEnum):
+    """Example of an IntEnum enum."""
+
+    VALUE10 = 10
+    VALUE20 = 20
+    VALUE30 = 30
+
+
+class MyStrEnum(str, enum.Enum):
+    """Example of a mixin string enum."""
+
+    VALUE1 = "value1"
+    VALUE2 = "value2"
+    VALUE3 = "value3"
+
+
+all_types_with_values = {
+    # supported scalar types
+    "bool": True,
+    "bytes": b"robotext",
+    "float": 13.12,
+    "int": 42,
+    "str": "sample string",
+    # supported collection types
+    "bool_collection": [True, False, True],
+    "bytes_collection": [b"one", b"two", b"three"],
+    "float_collection": [1.1, 2.2, 3.3],
+    "int_collection": [1, 2, 3],
+    "str_collection": ["one", "two", "three"],
+    # supported enum and flag types
+    "intflags": MyIntFlags.VALUE1 | MyIntFlags.VALUE4,
+    "intenum": MyIntEnum.VALUE20,
+    "strenum": MyStrEnum.VALUE3,
+    "intflags_collection": [MyIntFlags.VALUE1, MyIntFlags.VALUE2, MyIntFlags.VALUE4],
+    "intenum_collection": [MyIntEnum.VALUE10, MyIntEnum.VALUE20, MyIntEnum.VALUE30],
+    "strenum_collection": [MyStrEnum.VALUE1, MyStrEnum.VALUE2, MyStrEnum.VALUE3],
+    # supported collections
+    "list": [1, 2, 3],
+    "tuple": (4, 5, 6),
+    "set": {7, 8, 9},
+    "frozenset": frozenset([10, 11, 12]),
+    # NI types
+    "nitypes_Scalar": Scalar(42, "m"),
+    "nitypes_AnalogWaveform": AnalogWaveform.from_array_1d(np.array([1.0, 2.0, 3.0])),
+}

examples/all_types/define_types.py

@@ -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/README.md

@@ -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.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", ""))