ni.datastore 0.1.0.dev1__tar.gz

ni_datastore-0.1.0.dev1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 NI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ni_datastore-0.1.0.dev1/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.3
+Name: ni.datastore
+Version: 0.1.0.dev1
+Summary: APIs for publishing and retrieving data from the NI Measurement Data Store
+License: MIT
+Keywords: datastore
+Author: NI
+Author-email: opensource@ni.com
+Maintainer: Johann Scholtz
+Maintainer-email: johann.scholtz@emerson.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Dist: hightime (>=0.3.0.dev0)
+Requires-Dist: ni-datamonikers-v1-client (>=0.1.0.dev0)
+Requires-Dist: ni-measurements-data-v1-client (>=0.1.0.dev0)
+Requires-Dist: ni-measurements-metadata-v1-client (>=0.1.0.dev0)
+Requires-Dist: ni-protobuf-types (>=0.1.0.dev3)
+Requires-Dist: protobuf (>=4.21)
+Description-Content-Type: text/markdown
+
+# Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Measurement ]
+- [About](#about)
+  - [Operating System Support](#operating-system-support)
+  - [Python Version Support](#python-version-support)
+
+# Measurement Data Store API for Python
+
+`datastore-python` contains Python code for writing to and reading from
+the [NI Measurement Data Store](https://github.com/ni/datastore-service).
+It will include examples of how to use the Python API.
+
+# About
+
+`ni.datastore` is the main Python package in this repo that
+provides APIs for publishing and retrieving data from the NI
+Measurement Data Store
+
+NI created and supports this package.
+
+## Operating System Support
+
+`ni.datastore` supports Windows and Linux operating systems.
+
+## Python Version Support
+
+`ni.datastore` supports CPython 3.9+.
+
+## Installation
+
+You can directly install the `ni.datastore` package using `pip` or by listing it as a
+dependency in your project's `pyproject.toml` file.
+

ni_datastore-0.1.0.dev1/README.md

@@ -0,0 +1,34 @@
+# Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Measurement ]
+- [About](#about)
+  - [Operating System Support](#operating-system-support)
+  - [Python Version Support](#python-version-support)
+
+# Measurement Data Store API for Python
+
+`datastore-python` contains Python code for writing to and reading from
+the [NI Measurement Data Store](https://github.com/ni/datastore-service).
+It will include examples of how to use the Python API.
+
+# About
+
+`ni.datastore` is the main Python package in this repo that
+provides APIs for publishing and retrieving data from the NI
+Measurement Data Store
+
+NI created and supports this package.
+
+## Operating System Support
+
+`ni.datastore` supports Windows and Linux operating systems.
+
+## Python Version Support
+
+`ni.datastore` supports CPython 3.9+.
+
+## Installation
+
+You can directly install the `ni.datastore` package using `pip` or by listing it as a
+dependency in your project's `pyproject.toml` file.

ni_datastore-0.1.0.dev1/pyproject.toml

@@ -0,0 +1,113 @@
+[project]
+name = "ni.datastore"
+version = "0.1.0-dev1"
+license = "MIT"
+description = "APIs for publishing and retrieving data from the NI Measurement Data Store"
+authors = [{name = "NI", email = "opensource@ni.com"}]
+maintainers = [
+  {name = "Johann Scholtz", email = "johann.scholtz@emerson.com"},
+  {name = "Joel Dixon", email = "joel.dixon@emerson.com"}
+]
+readme = "README.md"
+repository = "https://github.com/ni/datastore-python"
+keywords = ["datastore"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Manufacturing",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: POSIX",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: Implementation :: CPython",
+]
+dynamic = ["dependencies"]
+requires-python = '>=3.9,<4.0'
+
+[tool.poetry]
+packages = [{include = "ni", from = "src"}]
+requires-poetry = '>=2.1,<3.0'
+
+[tool.poetry.dependencies]
+python = "^3.9"
+protobuf = {version=">=4.21"}
+ni-datamonikers-v1-client = { version = ">=0.1.0.dev0", allow-prereleases = true }
+ni-measurements-data-v1-client = { version = ">=0.1.0.dev0", allow-prereleases = true }
+ni-measurements-metadata-v1-client = { version = ">=0.1.0.dev0", allow-prereleases = true }
+ni-protobuf-types = { version = ">=0.1.0.dev3", allow-prereleases = true }
+hightime = { version = ">=0.3.0.dev0", allow-prereleases = true }
+
+[tool.poetry.group.dev.dependencies]
+types-grpcio = ">=1.0"
+types-protobuf = ">=4.21"
+ipykernel = ">=6.0"
+plotly = ">=5.0"
+nbformat = ">=4.2.0"
+ipython = ">=7.0"
+jupyter = ">=1.0" 
+
+[tool.poetry.group.lint.dependencies]
+bandit = { version = ">=1.7", extras = ["toml"] }
+ni-python-styleguide = ">=0.4.1"
+mypy = ">=1.0"
+pyright = { version = ">=1.1.400", extras = ["nodejs"] }
+
+[tool.poetry.group.test.dependencies]
+pytest = ">=7.2"
+pytest-cov = ">=4.0"
+pytest-doctestplus = ">=1.4"
+pytest-mock = ">=3.0"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+# The latest Sphinx requires a recent Python version.
+Sphinx = [
+  { version = ">=7.4", python = ">=3.9,<3.10" },
+  { version = ">=8.1", python = ">=3.10,<3.11" },
+  { version = ">=8.2", python = "^3.11" },
+]
+sphinx-rtd-theme = ">=1.0.0"
+sphinx-autoapi = ">=1.8.4"
+m2r2 = ">=0.3.2"
+toml = ">=0.10.2"
+
+[build-system]
+requires = ["poetry-core>=1.8"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.bandit]
+skips = [
+  "B101", # assert_used
+]
+
+[tool.ni-python-styleguide]
+extend_exclude = "docs,examples"
+
+[tool.black]
+extend-exclude = 'docs/|_pb2(_grpc)?\.(py|pyi)$'
+line-length = 100
+
+[tool.mypy]
+mypy_path = "src"
+files = "."
+namespace_packages = true
+strict = true
+explicit_package_bases = true
+exclude = ["docs"]
+
+[tool.pyright]
+include = ["src/", "tests/"]
+exclude = ["**/*_pb2_grpc.py", "**/*_pb2_grpc.pyi", "**/*_pb2.py", "**/*_pb2.pyi", "src/ni/measurements/data/v1/**/__init__.py*"]
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules --doctest-plus --strict-markers"
+testpaths = ["tests"]

ni_datastore-0.1.0.dev1/src/ni/datastore/__init__.py

@@ -0,0 +1,66 @@
+"""Public API for accessing the NI Data Store Service."""
+
+from ni.datamonikers.v1.data_moniker_pb2 import Moniker
+from ni.datastore._client import Client
+from ni.datastore._types._alias import Alias
+from ni.datastore._types._extension_schema import ExtensionSchema
+from ni.datastore._types._hardware_item import HardwareItem
+from ni.datastore._types._operator import Operator
+from ni.datastore._types._published_condition import PublishedCondition
+from ni.datastore._types._published_measurement import PublishedMeasurement
+from ni.datastore._types._software_item import SoftwareItem
+from ni.datastore._types._step import Step
+from ni.datastore._types._test import Test
+from ni.datastore._types._test_adapter import TestAdapter
+from ni.datastore._types._test_description import TestDescription
+from ni.datastore._types._test_result import TestResult
+from ni.datastore._types._test_station import TestStation
+from ni.datastore._types._uut import Uut
+from ni.datastore._types._uut_instance import UutInstance
+from ni.measurements.data.v1.data_store_pb2 import ErrorInformation, Outcome
+from ni.measurements.metadata.v1.metadata_store_pb2 import AliasTargetType
+
+__all__ = [
+    "Client",
+    "Alias",
+    "AliasTargetType",
+    "ErrorInformation",
+    "ExtensionSchema",
+    "HardwareItem",
+    "Moniker",
+    "Operator",
+    "Outcome",
+    "PublishedCondition",
+    "PublishedMeasurement",
+    "SoftwareItem",
+    "Step",
+    "Test",
+    "TestAdapter",
+    "TestDescription",
+    "TestResult",
+    "TestStation",
+    "Uut",
+    "UutInstance",
+]
+
+# Hide that it was not defined in this top-level package
+Client.__module__ = __name__
+Alias.__module__ = __name__
+AliasTargetType.__module__ = __name__
+ErrorInformation.__module__ = __name__
+ExtensionSchema.__module__ = __name__
+HardwareItem.__module__ = __name__
+Moniker.__module__ = __name__
+Operator.__module__ = __name__
+Outcome.__module__ = __name__
+PublishedCondition.__module__ = __name__
+PublishedMeasurement.__module__ = __name__
+SoftwareItem.__module__ = __name__
+Step.__module__ = __name__
+Test.__module__ = __name__
+TestAdapter.__module__ = __name__
+TestDescription.__module__ = __name__
+TestResult.__module__ = __name__
+TestStation.__module__ = __name__
+Uut.__module__ = __name__
+UutInstance.__module__ = __name__