Examples and Acceptance Tests - Separate Created/Published Data from Default Data Store

.github/workflows/CI.yml

@@ -15,12 +15,15 @@ jobs:
   check_examples:
       name: Check analyzers for examples
       uses: ./.github/workflows/check_examples.yml
+  check_utilities:
+      name: Check analyzers for utilities
+      uses: ./.github/workflows/check_utilities.yml
   check_docs:
     name: Check docs for ni.datastore
     uses: ./.github/workflows/check_docs.yml
   checks_succeeded:
       name: Checks succeeded
-      needs: [check_analyzers, check_examples, check_docs]
+      needs: [check_analyzers, check_examples, check_utilities, check_docs]
       runs-on: ubuntu-latest
       steps:
         - run: exit 0

.github/workflows/check_utilities.yml

@@ -0,0 +1,30 @@
+name: Check utilities
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  check_utilities:
+    name: Analyze utilities
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+        python-version: [3.14]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          submodules: true
+      - name: Set up Python
+        uses: ni/python-actions/setup-python@9768589f3e50672173dad75a6fc181e4a85d33fa # v0.7.0
+        id: setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up Poetry
+        uses: ni/python-actions/setup-poetry@9768589f3e50672173dad75a6fc181e4a85d33fa # v0.7.0
+      - name: Analyze Python Project
+        uses: ni/python-actions/analyze-project@9768589f3e50672173dad75a6fc181e4a85d33fa # v0.7.0
+        with:
+          project-directory: ${{ github.workspace }}/utilities

.gitignore

@@ -4,6 +4,9 @@
 # Byte-compiled / optimized / DLL files
 __pycache__/
 
+# Directory for data generated from running examples and tests
+temp_data/
+
 # Unit tests
 .pytest_cache/
 test_results/

CONTRIBUTING.md

@@ -111,9 +111,9 @@ in the `datastore-python` repo. Here are the steps to follow to publish the pack
 
 1. From the main GitHub repo page, select "Create a new release".
 2. On the "New Release" page, create a new tag using the "Select Tag" drop down. The tag must be the package version, matching the
-value found in pyproject.toml. Example: `0.1.0-dev0`.
+value found in pyproject.toml. Example: `0.1.0.dev0`.
 3. Enter a title in the "Release title" field. The title should contain the package name and
-version in the format `ni.datastore <package-version>`. For example: `ni.datastore 0.1.0-dev0`.
+version in the format `ni.datastore <package-version>`. For example: `ni.datastore 0.1.0.dev0`.
 4. Click "Generate release notes" and edit the release notes.
   - Delete entries for PRs that do not affect users, such as "chore(deps):" and "fix(deps):" PRs.
   - Consider grouping related entries.

examples/notebooks/README.md

@@ -0,0 +1,11 @@
+# Example Notebooks
+
+The Jupyter Notebooks contained within the sub-directories of this directory demonstrate usage and functionality of the Measurement Data Store Python API.
+
+These notebooks make use of the main Python environment / kernel of `ni.datastore`. To execute the code in these notebooks, first execute the following command from the repo's root directory:
+
+```sh
+poetry install
+```
+
+After executing this command, select the environment that it creates as the kernel to use for executing any of the provided notebooks that is of interest to you.

examples/notebooks/alias/alias.ipynb

@@ -17,6 +17,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# Perform example-specific setup with the DataStoreContext. This is not needed when writing production code.\n",
+    "from utilities import DataStoreContext\n",
+    "data_store_context = DataStoreContext()\n",
+    "data_store_context.initialize()\n",
+    "\n",
     "from ni.datastore.metadata import MetadataStoreClient, Operator\n",
     "\n",
     "metadata_store_client = MetadataStoreClient()\n",
@@ -201,7 +206,7 @@
    "id": "1b253668",
    "metadata": {},
    "source": [
-    "## Close the client"
+    "## Clean up"
    ]
   },
   {
@@ -211,7 +216,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "metadata_store_client.close()"
+    "metadata_store_client.close()\n",
+    "\n",
+    "# Perform example-specific cleanup. This is not needed when writing production code.\n",
+    "data_store_context.close()"
    ]
   }
  ],

examples/notebooks/extension-attributes/extension_attributes.ipynb

@@ -17,6 +17,11 @@
       "metadata": {},
       "outputs": [],
       "source": [
+        "# Perform example-specific setup with the DataStoreContext. This is not needed when writing production code.\n",
+        "from utilities import DataStoreContext\n",
+        "data_store_context = DataStoreContext()\n",
+        "data_store_context.initialize()\n",
+        "\n",
         "from ni.datastore.metadata import MetadataStoreClient\n",
         "\n",
         "metadata_store_client = MetadataStoreClient()\n",
@@ -177,7 +182,7 @@
       "id": "f5e0fcfd",
       "metadata": {},
       "source": [
-        "## Close the Clients"
+        "## Clean Up"
       ]
     },
     {
@@ -188,7 +193,10 @@
       "outputs": [],
       "source": [
         "metadata_store_client.close()\n",
-        "data_store_client.close()"
+        "data_store_client.close()\n",
+        "\n",
+        "# Perform example-specific cleanup. This is not needed when writing production code.\n",
+        "data_store_context.close()"
       ]
     }
   ],

examples/notebooks/overview/publish_measurement.ipynb

@@ -17,6 +17,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# Perform example-specific setup with the DataStoreContext. This is not needed when writing production code.\n",
+    "from utilities import DataStoreContext\n",
+    "data_store_context = DataStoreContext()\n",
+    "data_store_context.initialize()\n",
+    "\n",
     "from ni.datastore.data import DataStoreClient\n",
     "from ni.datastore.metadata import MetadataStoreClient\n",
     "\n",
@@ -270,7 +275,7 @@
    "id": "9f731b1e",
    "metadata": {},
    "source": [
-    "## Close the clients"
+    "## Clean up"
    ]
   },
   {
@@ -281,7 +286,10 @@
    "outputs": [],
    "source": [
     "metadata_store_client.close()\n",
-    "data_store_client.close()"
+    "data_store_client.close()\n",
+    "\n",
+    "# Perform example-specific cleanup. This is not needed when writing production code.\n",
+    "data_store_context.close()"
    ]
   }
  ],

examples/notebooks/query/publish_sample_data.ipynb

@@ -42,6 +42,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# Perform example-specific setup with the DataStoreContext. This is not needed when writing production code.\n",
+    "from utilities import DataStoreContext\n",
+    "data_store_context = DataStoreContext()\n",
+    "data_store_context.initialize()\n",
+    "\n",
     "from ni.datastore.metadata import (\n",
     "    MetadataStoreClient,\n",
     "    HardwareItem,\n",
@@ -489,6 +494,28 @@
     "print(f\"   📓 Then: query_measurements.ipynb - Query test results and measurements\")"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "9dd49a41",
+   "metadata": {},
+   "source": [
+    "## Clean up"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "636a5c4b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "data_store_client.close()\n",
+    "metadata_store_client.close()\n",
+    "\n",
+    "# Perform example-specific cleanup. This is not needed when writing production code.\n",
+    "data_store_context.close()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "ecc3a180",

examples/notebooks/query/query_measurements.ipynb

@@ -35,6 +35,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# Perform example-specific setup with the DataStoreContext. This is not needed when writing production code.\n",
+    "from utilities import DataStoreContext\n",
+    "data_store_context = DataStoreContext()\n",
+    "data_store_context.initialize()\n",
+    "\n",
     "from ni.datastore.data import DataStoreClient\n",
     "\n",
     "data_store_client = DataStoreClient()"
@@ -210,7 +215,7 @@
    "id": "bb446f20",
    "metadata": {},
    "source": [
-    "## Close the client"
+    "## Clean up"
    ]
   },
   {
@@ -220,7 +225,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "data_store_client.close()"
+    "data_store_client.close()\n",
+    "\n",
+    "# Perform example-specific cleanup. This is not needed when writing production code.\n",
+    "data_store_context.close()"
    ]
   }
  ],

examples/notebooks/query/query_metadata.ipynb

@@ -35,6 +35,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# Perform example-specific setup with the DataStoreContext. This is not needed when writing production code.\n",
+    "from utilities import DataStoreContext\n",
+    "data_store_context = DataStoreContext()\n",
+    "data_store_context.initialize()\n",
+    "\n",
     "from ni.datastore.metadata import MetadataStoreClient\n",
     "\n",
     "metadata_store_client = MetadataStoreClient()"
@@ -372,6 +377,27 @@
     "    target_type_name = get_target_type_name(alias.target_type)\n",
     "    print(f\"  {alias.name} -> {target_type_name}\")\n"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9bafa1e4",
+   "metadata": {},
+   "source": [
+    "## Clean up"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d9f68454",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "metadata_store_client.close()\n",
+    "\n",
+    "# Perform example-specific cleanup. This is not needed when writing production code.\n",
+    "data_store_context.close()"
+   ]
   }
  ],
  "metadata": {

examples/notebooks/voltage-regulator/publish_waveforms.ipynb

@@ -27,6 +27,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# Perform example-specific setup with the DataStoreContext. This is not needed when writing production code.\n",
+    "from utilities import DataStoreContext\n",
+    "data_store_context = DataStoreContext()\n",
+    "data_store_context.initialize()\n",
+    "\n",
     "from ni.datastore.metadata import (\n",
     "    MetadataStoreClient,\n",
     "    HardwareItem,\n",
@@ -271,7 +276,7 @@
    "id": "a0317fe8",
    "metadata": {},
    "source": [
-    "## Close the clients"
+    "## Clean Up"
    ]
   },
   {
@@ -282,7 +287,10 @@
    "outputs": [],
    "source": [
     "metadata_store_client.close()\n",
-    "data_store_client.close()"
+    "data_store_client.close()\n",
+    "\n",
+    "# Perform example-specific cleanup. This is not needed when writing production code.\n",
+    "data_store_context.close()"
    ]
   }
  ],