Merge remote-tracking branch 'origin/main' into users/mprosser/fix-example-commands

Mike Prosser · Mike Prosser · commit 491ca39df23b · 2025-11-17T10:01:21.000-06:00
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
@@ -5,7 +5,7 @@
 **nipanel** is a Python package that provides support for creating and controlling measurement and visualization panels. It's developed by NI and enables Python applications to create Streamlit-based panels that can be served and controlled via gRPC services.
 
 ### Key Repository Information
-- **Language**: Python (3.9+)
+- **Language**: Python (3.10+)
 - **Package Manager**: Poetry 2.1+
 - **Framework**: Uses Streamlit for panel UI, gRPC for communication
 - **Size**: Medium-sized repository (~1300 lines of code in src/)
@@ -64,7 +64,7 @@ poetry run sphinx-build docs docs/_build --builder html --fail-on-warning
 ```
 
 ### Runtime Requirements
-- **Python**: 3.9+ (excludes 3.9.7 due to Streamlit incompatibility)
+- **Python**: 3.10+
 - **Poetry**: 2.1+ required for build system
 - **Virtual Environment**: Configured in-project (`.venv/` directory)
 
@@ -114,12 +114,12 @@ examples/
 
 The repository uses a comprehensive GitHub Actions pipeline:
 
-1. **check_nipanel.yml**: Runs on Windows, Ubuntu, macOS with Python 3.9, 3.13
+1. **check_nipanel.yml**: Runs on Windows, Ubuntu, macOS with Python 3.10, 3.13
    - Linting with `poetry run nps lint`
    - Type checking with `poetry run mypy`
    - Security scanning with `poetry run bandit -c pyproject.toml -r src/nipanel`
 
-2. **run_unit_tests.yml**: Cross-platform testing (Windows, Ubuntu) with Python 3.9-3.13
+2. **run_unit_tests.yml**: Cross-platform testing (Windows, Ubuntu) with Python 3.10-3.13
    - Unit tests: `poetry run pytest ./tests/unit -v --cov=nipanel --junitxml=test_results/nipanel-{os}-py{version}.xml`
 
 3. **check_docs.yml**: Documentation validation
@@ -163,7 +163,6 @@ poetry run pytest -v
 1. **Poetry Lock Issues**: Run `poetry check --lock` to verify lock file consistency
 2. **Import Warnings**: flake8_import_order pkg_resources warnings are expected and harmless
 3. **Documentation SSL Errors**: External inventory fetch failures are known issues
-4. **Python 3.9.7**: Excluded due to Streamlit incompatibility - use different Python 3.9.x version
 
 ### File System Requirements
 - Virtual environment created in `.venv/` (configured in poetry.toml)
diff --git a/.github/workflows/check_docs.yml b/.github/workflows/check_docs.yml
@@ -28,7 +28,7 @@ jobs:
       - name: Generate docs
         run:  poetry run sphinx-build docs docs/_build -b html -W
       - name: Upload docs artifact
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
         with:
           name: nipanel-docs
           path: docs/_build/
diff --git a/.github/workflows/check_nipanel.yml b/.github/workflows/check_nipanel.yml
@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
-        python-version: [3.9, 3.13]
+        python-version: ["3.10", 3.13]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Check out repo
@@ -27,4 +27,4 @@ jobs:
         with:
           install-args: "--with examples"
       - name: Bandit security checks
-        run:  poetry run bandit -c pyproject.toml -r src/nipanel
+        run: poetry run bandit -c pyproject.toml -r src/nipanel
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -54,7 +54,7 @@ jobs:
       - name: Build distribution packages
         run: poetry build
       - name: Upload build artifacts
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
         with:
           name: ${{ env.dist-artifact-name }}
           path: dist/*
@@ -71,7 +71,7 @@ jobs:
       id-token: write
     steps:
     - name: Download build artifacts
-      uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
+      uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
       with:
         name: ${{ env.dist-artifact-name }}
         path: dist/
diff --git a/.github/workflows/report_test_results.yml b/.github/workflows/report_test_results.yml
@@ -16,7 +16,7 @@ jobs:
       - name: Check out repo
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: Download test results
-        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
         with:
           path: test_results
           pattern: test_results_*
diff --git a/.github/workflows/run_unit_tests.yml b/.github/workflows/run_unit_tests.yml
@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest]
-        python-version: [3.9, '3.10', 3.11, 3.12, 3.13]
+        python-version: ["3.10", 3.11, 3.12, 3.13]
       # Fail-fast skews the pass/fail ratio and seems to make pytest produce
       # incomplete JUnit XML results.
       fail-fast: false
@@ -35,7 +35,7 @@ jobs:
       - name: Run unit tests and code coverage
         run: poetry run pytest ./tests/unit -v --cov=nipanel --junitxml=test_results/nipanel-${{ matrix.os }}-py${{ matrix.python-version }}.xml
       - name: Upload test results
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
         with:
           name: test_results_unit_${{ matrix.os }}_py${{ matrix.python-version }}
           path: ./test_results/*.xml
diff --git a/README.md b/README.md
@@ -4,6 +4,7 @@
 - [About](#about)
   - [Operating System Support](#operating-system-support)
   - [Python Version Support](#python-version-support)
+  - [Installation](#installation)
 
 # About
 
@@ -17,4 +18,13 @@ NI created and supports this package.
 
 ## Python Version Support
 
-`nipanel` supports CPython 3.9+.
+`nipanel` supports CPython 3.10+.
+
+## Installation
+
+As a prerequisite to using the `nipanel` module, you must install InstrumentStudio 2026 Q1
+or later on your system. You can download and install this software using
+[NI Package Manager](https://www.ni.com/en/support/downloads/software-products/download.package-manager.html).
+
+You can directly install the `nipanel` package using `pip` or by listing it as a
+dependency in your project's `pyproject.toml` file.
diff --git a/examples/all_types/README.md b/examples/all_types/README.md
@@ -8,7 +8,7 @@ This is an example for `nipanel` that demonstrates all supported data types.
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/examples/hello/README.md b/examples/hello/README.md
@@ -8,7 +8,7 @@ This is a simple `nipanel` example that displays a Streamlit app.
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/examples/nidaqmx/nidaqmx_analog_input_filtering/README.md b/examples/nidaqmx/nidaqmx_analog_input_filtering/README.md
@@ -12,7 +12,7 @@ Script demonstrates analog input data getting continuously acquired, and being f
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/examples/nidaqmx/nidaqmx_analog_output_voltage/README.md b/examples/nidaqmx/nidaqmx_analog_output_voltage/README.md
@@ -12,7 +12,7 @@ This is a nipanel example that displays an interactive Streamlit app and updates
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/examples/nidaqmx/nidaqmx_continuous_analog_input/README.md b/examples/nidaqmx/nidaqmx_continuous_analog_input/README.md
@@ -12,7 +12,7 @@ This is a nipanel example that displays an interactive Streamlit app and updates
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/examples/niscope/niscope_binary_acquisition/README.md b/examples/niscope/niscope_binary_acquisition/README.md
@@ -13,7 +13,7 @@ Script demonstrates waveform data getting continuously acquired and being conver
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/examples/niscope/niscope_configured_acquisition/README.md b/examples/niscope/niscope_configured_acquisition/README.md
@@ -13,7 +13,7 @@ Script demonstrates how to configure vertical, horizontal, and triggering proper
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/examples/niscope/niscope_ex_fetch_forever/README.md b/examples/niscope/niscope_ex_fetch_forever/README.md
@@ -13,7 +13,7 @@ Script demonstrates NIScope waveform data getting continuously acquired.
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/examples/performance_checker/README.md b/examples/performance_checker/README.md
@@ -11,7 +11,7 @@ This example measures the performance of a streamlit panel with a graph.
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/examples/simple_graph/README.md b/examples/simple_graph/README.md
@@ -11,7 +11,7 @@ This example demonstrates using `nipanel` with Streamlit to display a dynamic si
 
 ### Required Software
 
-- Python 3.9 or later
+- Python 3.10 or later
 
 ### Usage
 
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
