nominal 1.98.0__py3-none-any.whl → 1.99.0__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.99.0](https://github.com/nominal-io/nominal-client/compare/v1.98.0...v1.99.0) (2025-12-04)
+
+
+### Features
+
+* allow ingesting .avro files ([#544](https://github.com/nominal-io/nominal-client/issues/544)) ([f5c4561](https://github.com/nominal-io/nominal-client/commit/f5c4561e1db6174a56d6b32b388ed7ad94679fdf))
+
 ## [1.98.0](https://github.com/nominal-io/nominal-client/compare/v1.97.0...v1.98.0) (2025-12-04)
 
 

nominal/core/dataset.py

@@ -203,6 +203,78 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
     # Backward compatibility
     add_to_dataset_from_io = add_from_io
 
+    def add_avro_stream(
+        self,
+        path: Path | str,
+    ) -> DatasetFile:
+        """Upload an avro stream file with a specific schema, described below.
+
+        This is a "stream-like" file format to support
+        use cases where a columnar/tabular format does not make sense. This closely matches Nominal's streaming
+        API, making it useful for use cases where network connection drops during streaming and a backup file needs
+        to be created.
+
+        If this schema is not used, will result in a failed ingestion.
+        {
+            "type": "record",
+            "name": "AvroStream",
+            "namespace": "io.nominal.ingest",
+            "fields": [
+                {
+                    "name": "channel",
+                    "type": "string",
+                    "doc": "Channel/series name (e.g., 'vehicle_id', 'col_1', 'temperature')",
+                },
+                {
+                    "name": "timestamps",
+                    "type": {"type": "array", "items": "long"},
+                    "doc": "Array of Unix timestamps in nanoseconds",
+                },
+                {
+                    "name": "values",
+                    "type": {"type": "array", "items": ["double", "string"]},
+                    "doc": "Array of values. Can either be doubles or strings",
+                },
+                {
+                    "name": "tags",
+                    "type": {"type": "map", "values": "string"},
+                    "default": {},
+                    "doc": "Key-value metadata tags",
+                },
+            ],
+        }
+
+        Args:
+            path: Path to the .avro file to upload
+
+        Returns:
+            Reference to the ingesting DatasetFile
+
+        """
+        avro_path = Path(path)
+        s3_path = upload_multipart_file(
+            self._clients.auth_header,
+            self._clients.workspace_rid,
+            avro_path,
+            self._clients.upload,
+            file_type=FileTypes.AVRO_STREAM,
+        )
+        target = ingest_api.DatasetIngestTarget(
+            existing=ingest_api.ExistingDatasetIngestDestination(dataset_rid=self.rid)
+        )
+        resp = self._clients.ingest.ingest(
+            self._clients.auth_header,
+            ingest_api.IngestRequest(
+                options=ingest_api.IngestOptions(
+                    avro_stream=ingest_api.AvroStreamOpts(
+                        source=ingest_api.IngestSource(s3=ingest_api.S3IngestSource(s3_path)),
+                        target=target,
+                    )
+                )
+            ),
+        )
+        return self._handle_ingest_response(resp)
+
     def add_journal_json(
         self,
         path: Path | str,

nominal/core/filetype.py

@@ -111,6 +111,7 @@ class FileType(NamedTuple):
 
 
 class FileTypes:
+    AVRO_STREAM: FileType = FileType(".avro", "application/avro")
     BINARY: FileType = FileType("", "application/octet-stream")
     CSV: FileType = FileType(".csv", "text/csv")
     CSV_GZ: FileType = FileType(".csv.gz", "text/csv")

{nominal-1.98.0.dist-info → nominal-1.99.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nominal
-Version: 1.98.0
+Version: 1.99.0
 Summary: Automate Nominal workflows in Python
 Project-URL: Homepage, https://nominal.io
 Project-URL: Documentation, https://docs.nominal.io

{nominal-1.98.0.dist-info → nominal-1.99.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-CHANGELOG.md,sha256=gqkvZQ_HzybFgggDMLGPXEt7eyGDq6jDf26HGFVlKLY,80650
+CHANGELOG.md,sha256=52CVvxyESwAGvmBLo5soPa95wuhlqckBIYFLtsSI9zE,80966
 LICENSE,sha256=zEGHG9mjDjaIS3I79O8mweQo-yiTbqx8jJvUPppVAwk,1067
 README.md,sha256=KKe0dxh_pHXCtB7I9G4qWGQYvot_BZU8yW6MJyuyUHM,311
 nominal/__init__.py,sha256=rbraORnXUrNn1hywLXM0XwSQCd9UmQt20PDYlsBalfE,2167
@@ -39,12 +39,12 @@ nominal/core/client.py,sha256=L6IQVEPTiKbOjtbn4G0_R90jbVeOOxpHBHmminGQ3FE,67403
 nominal/core/connection.py,sha256=ySbPN_a2takVa8wIU9mK4fB6vYLyZnN-qSmXVkLUxAY,5157
 nominal/core/containerized_extractors.py,sha256=HrcMJzdE-hH66AgYIA0LTeFELsBHa0Sm0vlsKMiIzDU,9501
 nominal/core/data_review.py,sha256=bEnRsd8LI4x9YOBPcF2H3h5-e12A7Gh8gQfsNUAZmPQ,7922
-nominal/core/dataset.py,sha256=gbQYtAYx-fHaewOZUSC7P9CHlMfmdchtTv1XUuNKg3Y,29933
+nominal/core/dataset.py,sha256=q8V5ULrGO-wHBbhm7_Qd_nXzp-D5FTQGfyYbIxhIvjI,32567
 nominal/core/dataset_file.py,sha256=oENANJ17A4K63cZ8Fr7lUm_kVPyA4fL2rUsZ3oXXk2U,16396
 nominal/core/datasource.py,sha256=D9jHirAzUZ0pc3nW1XIURpw1UqQoA2E-nUUylZR1jbE,16707
 nominal/core/event.py,sha256=D8qIX_dTjfSHN7jFW8vV-9htbQTaqk9VvRfK7t-sbbw,5891
 nominal/core/exceptions.py,sha256=GUpwXRgdYamLl6684FE8ttCRHkBx6WEhOZ3NPE-ybD4,2671
-nominal/core/filetype.py,sha256=OgUWR9Ebr-KGVNoXZCnxlHZh9Tp3g9kY1VeTv4TULPQ,5399
+nominal/core/filetype.py,sha256=jAPe6F7pDT8ixsD2-Y8eJdHOxgimdEQte4RQybWwsos,5465
 nominal/core/log.py,sha256=z3hI3CIEyMwpUSWjwBsJ6a3JNGzBbsmrVusSU6uI7CY,3885
 nominal/core/run.py,sha256=IvKyvyQ9sOefQQorDbOo1KHSGNtNN_9OnsJajlgoRSg,14803
 nominal/core/secret.py,sha256=Ckq48m60i7rktxL9GY-nxHU5v8gHv9F1-JN7_MSf4bM,2863
@@ -102,8 +102,8 @@ nominal/thirdparty/polars/polars_export_handler.py,sha256=hGCSwXX9dC4MG01CmmjlTb
 nominal/thirdparty/tdms/__init__.py,sha256=6n2ImFr2Wiil6JM1P5Q7Mpr0VzLcnDkmup_ftNpPq-s,142
 nominal/thirdparty/tdms/_tdms.py,sha256=eiHFTUviyDPDClckNldjs_jTTSH_sdmboKDq0oIGChQ,8711
 nominal/ts/__init__.py,sha256=hmd0ENvDhxRnzDKGLxIub6QG8LpcxCgcyAct029CaEs,21442
-nominal-1.98.0.dist-info/METADATA,sha256=av9CrAtGvlkkUC6pdW1oC7TazjZD1tJNIN46C4G4Jng,1946
-nominal-1.98.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-nominal-1.98.0.dist-info/entry_points.txt,sha256=-mCLhxgg9R_lm5efT7vW9wuBH12izvY322R0a3TYxbE,66
-nominal-1.98.0.dist-info/licenses/LICENSE,sha256=zEGHG9mjDjaIS3I79O8mweQo-yiTbqx8jJvUPppVAwk,1067
-nominal-1.98.0.dist-info/RECORD,,
+nominal-1.99.0.dist-info/METADATA,sha256=PEAgXJMK7XkQoxWyji_iTfWdSiZ31DcdzRBjVqF6Ixc,1946
+nominal-1.99.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+nominal-1.99.0.dist-info/entry_points.txt,sha256=-mCLhxgg9R_lm5efT7vW9wuBH12izvY322R0a3TYxbE,66
+nominal-1.99.0.dist-info/licenses/LICENSE,sha256=zEGHG9mjDjaIS3I79O8mweQo-yiTbqx8jJvUPppVAwk,1067
+nominal-1.99.0.dist-info/RECORD,,