Create a top-level ni-measurement-plugin-sdk meta package

.github/workflows/Publish_NIMS.yml

@@ -47,11 +47,17 @@ jobs:
       - name: Update NIMS package version based on tag name.
         run: |
           poetry version ${{ steps.vars.outputs.tag }}
+          working-directory: ./packages/service
 
       - name: Update NIMG package version based on tag name.
         run: |
           poetry version ${{ steps.vars.outputs.tag }}
-        working-directory: ./ni_measurement_plugin_sdk_generator
+        working-directory: ./packages/generator
+
+      - name: Update SDK package version based on tag name.
+        run: |
+          poetry version ${{ steps.vars.outputs.tag }}
+        working-directory: ./packages/sdk
 
       - name: Commit file changes
         id: commit
@@ -84,7 +90,13 @@ jobs:
         if: ${{ startsWith(github.event.release.target_commitish, 'main') || startsWith(github.event.release.target_commitish, 'releases/') }}
         run: |
           poetry publish --build --username __token__ --password ${{ secrets.PYPI_TOKEN }}
-        working-directory: ./ni_measurement_plugin_sdk_generator
+        working-directory: ./packages/generator
+
+      - name: Build SDK Python package and publish to PyPI
+        if: ${{ startsWith(github.event.release.target_commitish, 'main') || startsWith(github.event.release.target_commitish, 'releases/') }}
+        run: |
+          poetry publish --build --username __token__ --password ${{ secrets.PYPI_TOKEN }}
+        working-directory: ./packages/sdk
 
       - name: Create archives of the examples
         env:

.github/workflows/check_examples.yml

@@ -31,7 +31,7 @@ jobs:
         with:
           path: 'examples/**/poetry.lock'
           # Include the main project's poetry.lock in the hash to detect upstream dependency updates.
-          key: examples-poetry-lock-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('examples/**/pyproject.toml', 'poetry.lock') }}
+          key: examples-poetry-lock-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('examples/**/pyproject.toml', 'packages/service/poetry.lock') }}
       - name: Lock examples
         if: steps.cache-poetry-lock.outputs.cache-hit != 'true'
         run: |

.github/workflows/check_nimg.yml

@@ -15,7 +15,7 @@ jobs:
     defaults:
       run:
         # Set the working-directory for all steps in this job.
-        working-directory: ./ni_measurement_plugin_sdk_generator
+        working-directory: ./packages/generator
     steps:
       - name: Check out repo
         uses: actions/checkout@v4
@@ -34,8 +34,8 @@ jobs:
         uses: actions/cache@v4
         id: cache
         with:
-          path: ni_measurement_plugin_sdk_generator/.venv
-          key: ni-measurement-plugin-sdk-generator-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
+          path: packages/generator/.venv
+          key: ni-measurement-plugin-sdk-generator-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('packages/generator/poetry.lock') }}
       - name: Install ni-measurement-plugin-sdk-generator
         run: poetry install -v
       - name: Lint ni-measurement-plugin-sdk-generator

.github/workflows/check_nims.yml

@@ -12,6 +12,10 @@ jobs:
   check_nims:
     name: Check NIMS
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        # Set the working-directory for all steps in this job.
+        working-directory: ./packages/service
     steps:
       - name: Check out repo
         uses: actions/checkout@v4
@@ -34,15 +38,15 @@ jobs:
         uses: actions/cache/restore@v4
         id: restore-nims-all-extras
         with:
-          path: .venv
-          key: ni-measurement-plugin-sdk-service-all-extras-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
+          path: packages/service/.venv
+          key: ni-measurement-plugin-sdk-service-all-extras-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('packages/service/poetry.lock') }}
       - name: Install ni-measurement-plugin-sdk-service (all extras)
         run: poetry install -v --all-extras
       - name: Save cached virtualenv (ni-measurement-plugin-sdk-service, all extras)
         uses: actions/cache/save@v4
         if: steps.restore-nims-all-extras.outputs.cache-hit != 'true'
         with:
-          path: .venv
+          path: packages/service/.venv
           key: ${{ steps.restore-nims-all-extras.outputs.cache-primary-key }}
       - name: Lint ni-measurement-plugin-sdk-service
         run: poetry run ni-python-styleguide lint
@@ -60,23 +64,23 @@ jobs:
         uses: actions/cache/restore@v4
         id: restore-nims-all-extras-docs
         with:
-          path: .venv
-          key: ni-measurement-plugin-sdk-service-all-extras-docs-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
+          path: packages/service/.venv
+          key: ni-measurement-plugin-sdk-service-all-extras-docs-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('packages/service/poetry.lock') }}
       - name: Install ni-measurement-plugin-sdk-service (all extras, docs)
         run: poetry install -v --all-extras --with docs
       - name: Save cached virtualenv (ni-measurement-plugin-sdk-service, all extras, docs)
         uses: actions/cache/save@v4
         if: steps.restore-nims-all-extras-docs.outputs.cache-hit != 'true'
         with:
-          path: .venv
+          path: packages/service/.venv
           key: ${{ steps.restore-nims-all-extras-docs.outputs.cache-primary-key }}
       - name: Build docs and check for errors/warnings
         run: |
           rm -rf docs
           mkdir -p docs   
           poetry run sphinx-build _docs_source docs -b html -W --keep-going
       - name: Revert docs
-        run:  git clean -dfx docs/ && git restore docs/
+        run:  rm -rf docs
       - name: Generate gRPC stubs
         run: |
           find ni_measurement_plugin_sdk_service/_internal/stubs/ -name \*_pb2.py\* -o -name \*_pb2_grpc.py\* -delete

.github/workflows/run_system_tests.yml

@@ -12,6 +12,10 @@ jobs:
       - windows
       - x64
       - rdss-measlinkbot-win-10-${{ matrix.configuration }}
+    defaults:
+      run:
+        # Set the working-directory for all steps in this job.
+        working-directory: ./packages/service
     strategy:
       matrix:
         configuration: ["py32", "py64"]
@@ -24,14 +28,15 @@ jobs:
         uses: actions/checkout@v4
       - name: Copy and rename .env.simulation to .env
         run: cp examples/.env.simulation .env
+        working-directory: ./
       - name: Cache virtualenvs
         uses: actions/cache@v4
         id: cache
         with:
           path: |
-            .venv
-            .tox
-          key: run-system-tests-${{ runner.os }}-${{ matrix.configuration }}-${{ hashFiles('poetry.lock') }}
+            packages/service/.venv
+            packages/service/.tox
+          key: run-system-tests-${{ runner.os }}-${{ matrix.configuration }}-${{ hashFiles('packages/service/poetry.lock') }}
       - name: Install dependencies
         run: poetry install -v
       - name: Run system tests
@@ -40,5 +45,5 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: test_results
-          path: test_results/*.xml
+          path: ./packages/service/test_results/*.xml
         if: always()

.github/workflows/run_unit_tests.yml

@@ -36,56 +36,60 @@ jobs:
         uses: actions/cache/restore@v4
         id: restore-nims-no-extras
         with:
-          path: .venv
-          key: ni-measurement-plugin-sdk-service-no-extras-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
+          path: packages/service/.venv
+          key: ni-measurement-plugin-sdk-service-no-extras-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('packages/service/poetry.lock') }}
       - name: Install ni-measurement-plugin-sdk-service (no extras)
         run: poetry install -v
+        working-directory: ./packages/service
       - name: Save cached virtualenv (ni-measurement-plugin-sdk-service, no extras)
         uses: actions/cache/save@v4
         if: steps.restore-nims-no-extras.outputs.cache-hit != 'true'
         with:
-          path: .venv
+          path: packages/service/.venv
           key: ${{ steps.restore-nims-no-extras.outputs.cache-primary-key }}
       - name: Run unit tests and code coverage (ni-measurement-plugin-sdk-service, no extras)
         run: poetry run pytest ./tests/unit -v --cov=ni_measurement_plugin_sdk_service --junitxml=test_results/nims-${{ matrix.os }}-py${{ matrix.python-version}}-no-extras.xml
+        working-directory: ./packages/service
 
       # ni-measurement-plugin-sdk-service, all extras
       - name: Restore cached virtualenv (ni-measurement-plugin-sdk-service, all extras)
         uses: actions/cache/restore@v4
         id: restore-nims-all-extras
         with:
-          path: .venv
-          key: ni-measurement-plugin-sdk-service-all-extras-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
+          path: packages/service/.venv
+          key: ni-measurement-plugin-sdk-service-all-extras-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('packages/service/poetry.lock') }}
       - name: Install ni-measurement-plugin-sdk-service (all extras)
         run: poetry install -v --all-extras
+        working-directory: ./packages/service
       - name: Save cached ni-measurement-plugin-sdk-service virtualenv (all extras)
         uses: actions/cache/save@v4
         if: steps.restore-nims-all-extras.outputs.cache-hit != 'true'
         with:
-          path: .venv
+          path: packages/service/.venv
           key: ${{ steps.restore-nims-all-extras.outputs.cache-primary-key }}
       - name: Run unit tests and code coverage (ni-measurement-plugin-sdk-service, all extras)
         run: poetry run pytest ./tests/unit -v --cov=ni_measurement_plugin_sdk_service --junitxml=test_results/nims-${{ matrix.os }}-py${{ matrix.python-version}}-all-extras.xml
+        working-directory: ./packages/service
 
       # ni-measurement-plugin-sdk-generator
       - name: Restore cached virtualenv (ni-measurement-plugin-sdk-generator)
         uses: actions/cache/restore@v4
         id: restore-nimg
         with:
-          path: ni_measurement_plugin_sdk_generator/.venv
-          key: ni-measurement-plugin-sdk-generator-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('poetry.lock') }}
+          path: packages/generator/.venv
+          key: ni-measurement-plugin-sdk-generator-${{ runner.os }}-py${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('packages/generator/poetry.lock') }}
       - name: Install ni-measurement-plugin-sdk-generator
         run: poetry install -v
-        working-directory: ./ni_measurement_plugin_sdk_generator
+        working-directory: ./packages/generator
       - name: Save cached virtualenv (ni-measurement-plugin-sdk-generator)
         uses: actions/cache/save@v4
         if: steps.restore-nimg.outputs.cache-hit != 'true'
         with:
-          path: ni_measurement_plugin_sdk_generator/.venv
+          path: packages/generator/.venv
           key: ${{ steps.restore-nimg.outputs.cache-primary-key }}
       - name: Run tests and code coverage (ni-measurement-plugin-sdk-generator)
         run: poetry run pytest -v --cov=ni_measurement_plugin_sdk_generator --junitxml=test_results/nimg-${{ matrix.os }}-py${{ matrix.python-version}}.xml
-        working-directory: ./ni_measurement_plugin_sdk_generator
+        working-directory: ./packages/generator
 
       - name: Upload test results
         uses: actions/upload-artifact@v3

.readthedocs.yml

@@ -6,11 +6,11 @@ build:
     python: "3.9"
   jobs:
     post_create_environment:
-      - pip install poetry==1.2.2
+      - pip install poetry==1.8.2
       # Tell poetry to not use a virtual environment
       - poetry config virtualenvs.create false
     post_install:
       - poetry install --with docs
 
 sphinx:
-  configuration: _docs_source/conf.py
+  configuration: packages/service/_docs_source/conf.py

docs/CNAME

@@ -1 +1 @@
-measurementlink-python.readthedocs.io
+measurement-plugin-python.readthedocs.io

packages/sdk/README.md

@@ -0,0 +1,23 @@
+# Measurement Plug-In SDK for Python
+---
+
+## Introduction
+
+Measurement Plug-In SDK for Python (`ni-measurement-plugin-sdk`) is a
+tool for generating and writing reusable measurement plug-ins using gRPC services.
+
+The purpose of this package is as a meta-package that depends on `ni-measurement-plugin-sdk-generator`
+and `ni-measurement-plugin-sdk-service` so as to easily install all the things needed for the
+Measurement Plug-In SDK.
+
+For installation and usage, see [Measurement Plug-In SDK for Python (`ni-measurement-plugin-sdk-service`)](https://pypi.org/project/ni-measurement-plugin-sdk-service/).
+
+---
+
+## Dependencies
+
+- Python >= 3.8 [(3.9 recommended)](https://www.python.org/downloads/release/python-3913/)
+- [mako >= 1.2.1, < 2.x](https://pypi.org/project/Mako/1.2.1/)
+- [click >= 8.1.3](https://pypi.org/project/click/8.1.3/)
+
+---

packages/sdk/ni_measurement_plugin_sdk/__init__.py

@@ -0,0 +1 @@
+"""Measurement Plugin SDK for Python."""