nominal 1.95.0__tar.gz → 1.96.0__tar.gz

{nominal-1.95.0 → nominal-1.96.0}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [1.96.0](https://github.com/nominal-io/nominal-client/compare/v1.95.0...v1.96.0) (2025-12-03)
+
+
+### Features
+
+* add tags to dataflash apis ([#534](https://github.com/nominal-io/nominal-client/issues/534)) ([00cd79f](https://github.com/nominal-io/nominal-client/commit/00cd79fdb84e299a4013b69ce9639cfc75644b32))
+* remove deprecated fields, methods, files ([#525](https://github.com/nominal-io/nominal-client/issues/525)) ([e11175d](https://github.com/nominal-io/nominal-client/commit/e11175de0e303d97d91efa7eaf6ee6010d6b08ef))
+* reorder methods in run and asset class ([#530](https://github.com/nominal-io/nominal-client/issues/530)) ([5813157](https://github.com/nominal-io/nominal-client/commit/58131574bd85a82d36f7e76f18279c8c7cfaf1a8))
+
 ## [1.95.0](https://github.com/nominal-io/nominal-client/compare/v1.94.0...v1.95.0) (2025-11-19)
 
 

{nominal-1.95.0 → nominal-1.96.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nominal
-Version: 1.95.0
+Version: 1.96.0
 Summary: Automate Nominal workflows in Python
 Project-URL: Homepage, https://nominal.io
 Project-URL: Documentation, https://docs.nominal.io
@@ -20,7 +20,7 @@ Requires-Dist: cachetools>=6.1.0
 Requires-Dist: click<9,>=8
 Requires-Dist: conjure-python-client<4,>=3.1.0
 Requires-Dist: ffmpeg-python>=0.2.0
-Requires-Dist: nominal-api==0.982.0
+Requires-Dist: nominal-api==0.1019.0
 Requires-Dist: nominal-streaming==0.5.8
 Requires-Dist: openpyxl>=0.0.0
 Requires-Dist: pandas>=0.0.0

{nominal-1.95.0 → nominal-1.96.0}/nominal/cli/__init__.py

@@ -2,7 +2,7 @@ import importlib.metadata
 
 import click
 
-from nominal.cli import attachment, auth, config, dataset, download, mis, run
+from nominal.cli import attachment, config, dataset, download, mis, run
 
 
 @click.group(context_settings={"show_default": True, "help_option_names": ("-h", "--help")})
@@ -12,7 +12,6 @@ def nom() -> None:
 
 
 nom.add_command(attachment.attachment_cmd)
-nom.add_command(auth.auth_cmd)
 nom.add_command(config.config_cmd)
 nom.add_command(dataset.dataset_cmd)
 nom.add_command(download.download_cmd)

{nominal-1.95.0 → nominal-1.96.0}/nominal/cli/auth.py

@@ -1,12 +1,9 @@
 from __future__ import annotations
 
-import warnings
-
 import click
 
 from nominal.cli.util.global_decorators import global_options
-from nominal.cli.util.verify_connection import validate_token_url
-from nominal.config import _config as _deprecated_config
+from nominal.core.exceptions import NominalMethodRemovedError
 
 
 @click.group(name="auth")
@@ -25,12 +22,4 @@ def set_token(token: str, base_url: str) -> None:
 
     Update the token for a given URL in the (deprecated) Nominal config file
     """
-    warnings.warn(
-        "`nom auth set-token` is deprecated, use `nom config profile add` instead",
-        UserWarning,
-        stacklevel=2,
-    )
-    path = _deprecated_config._DEFAULT_NOMINAL_CONFIG_PATH
-    validate_token_url(token, base_url, None)
-    _deprecated_config.set_token(base_url, token)
-    click.secho(f"Successfully set token for '{base_url}' in {path}", fg="green")
+    raise NominalMethodRemovedError("nominal auth set-token", "use 'nominal config profile add' instead")

{nominal-1.95.0 → nominal-1.96.0}/nominal/cli/dataset.py

@@ -70,7 +70,7 @@ def upload_csv(
         description=description,
         prefix_tree_delimiter=channel_name_delimiter,
     )
-    dataset.add_tabular_data(
+    dataset_file = dataset.add_tabular_data(
         file,
         timestamp_column=timestamp_column,
         timestamp_type=timestamp_type,
@@ -78,7 +78,7 @@ def upload_csv(
 
     # block until ingestion completed, if requested
     if wait:
-        dataset.poll_until_ingestion_completed()
+        dataset_file.poll_until_ingestion_completed()
 
     click.echo(dataset)
 

{nominal-1.95.0 → nominal-1.96.0}/nominal/cli/util/click_log_handler.py

@@ -4,7 +4,7 @@ import logging
 
 from typing_extensions import deprecated
 
-from nominal.experimental.logging import ClickLogHandler, install_click_log_handler
+from nominal.core.exceptions import NominalMethodRemovedError
 
 
 @deprecated(
@@ -20,7 +20,10 @@ def install_log_handler(level: int = logging.WARNING, no_color: bool = False) ->
         no_color: If true, prevents log messages from being stylized by severity level
 
     """
-    install_click_log_handler(level=level, no_color=no_color)
+    raise NominalMethodRemovedError(
+        "nominal.cli.util.install_log_handler",
+        "use nominal.experimental.logging.install_click_log_handler instead",
+    )
 
 
-__all__ = ["ClickLogHandler", "install_log_handler"]
+__all__ = ["install_log_handler"]

{nominal-1.95.0 → nominal-1.96.0}/nominal/cli/util/global_decorators.py

@@ -8,7 +8,6 @@ import typing
 
 import click
 
-from nominal.config._config import _DEFAULT_NOMINAL_CONFIG_PATH, get_token
 from nominal.core.client import NominalClient
 from nominal.experimental.logging import install_click_log_handler
 
@@ -105,14 +104,14 @@ def client_options(func: typing.Callable[Param, T]) -> typing.Callable[..., T]:
     """Decorator to add click options to a click command for dynamically creating and injecting an instance of the
     NominalClient into commands based on user-provided flags to configure its creation.
 
-    This will add three options, --profile, --base-url, and --token, which perform the three aforementioned
-    configurations before spawning a NominalClient.
+    This will add an option --profile which perform the aforementioned configurations before spawning a NominalClient.
 
     NOTE: any click command utilizing this decorator MUST accept a key-value argument pair named client of type
         NominalClient.
     """
     profile_option = click.option(
         "--profile",
+        required=True,
         help=(
             "If provided, use the given named config profile for instantiating a Nominal Client. "
             "This is the preferred mechanism for instantiating a client today-- see `nom config profile add` "
@@ -120,26 +119,6 @@ def client_options(func: typing.Callable[Param, T]) -> typing.Callable[..., T]:
             "--base-url."
         ),
     )
-    url_option = click.option(
-        "--base-url",
-        default="https://api.gov.nominal.io/api",
-        show_default=True,
-        help="Base URL of the Nominal API to hit. Useful for hitting other clusters, e.g., staging for internal users.",
-    )
-    token_path_option = click.option(
-        "--token-path",
-        default=_DEFAULT_NOMINAL_CONFIG_PATH,
-        type=click.Path(dir_okay=False, resolve_path=True, path_type=pathlib.Path),
-        show_default=True,
-        help="Path to the yaml file containing the Nominal access token for authenticating with the API",
-    )
-    token_option = click.option(
-        "--token",
-        help=(
-            "API Access token to use when creating the nominal client. "
-            "If provided, takes precedence over --token-path and --base-url"
-        ),
-    )
     trust_store_option = click.option(
         "--trust-store-path",
         type=click.Path(dir_okay=False, exists=True, resolve_path=True, path_type=pathlib.Path),
@@ -154,35 +133,14 @@ def client_options(func: typing.Callable[Param, T]) -> typing.Callable[..., T]:
         *args: Param.args,
         **kwargs: Param.kwargs,
     ) -> T:
-        profile: str | None = kwargs.pop("profile")  # type: ignore[assignment]
-        base_url: str = kwargs.pop("base_url", "")  # type: ignore[assignment]
-        token: str | None = kwargs.pop("token")  # type: ignore[assignment]
-        token_path: pathlib.Path = kwargs.pop("token_path")  # type: ignore[assignment]
+        profile: str = kwargs.pop("profile")  # type: ignore[assignment]
         trust_store_path: pathlib.Path | None = kwargs.pop("trust_store_path")  # type: ignore[assignment]
 
         trust_store_str = str(trust_store_path) if trust_store_path else None
 
-        if profile is not None:
-            logger.info("Instantiating client from profile '%s'", profile)
-            client = NominalClient.from_profile(profile, trust_store_path=trust_store_str)
-            kwargs["client"] = client
-            return func(*args, **kwargs)
-
-        logger.warning(
-            "Creating a Nominal Client without using '--profile' is deprecated! "
-            "See 'https://docs.nominal.io/core/sdk/python-client/authentication' for details..."
-        )
-
-        if token is None:
-            if token_path.exists():
-                token = get_token(base_url, token_path)
-            else:
-                raise ValueError(
-                    f"Cannot instantiate client: no token provided and token path {token_path} does not exist."
-                )
-
-        client = NominalClient.create(base_url, token=token, trust_store_path=trust_store_str)
+        logger.info("Instantiating client from profile '%s'", profile)
+        client = NominalClient.from_profile(profile, trust_store_path=trust_store_str)
         kwargs["client"] = client
         return func(*args, **kwargs)
 
-    return profile_option(token_option(token_path_option(url_option(trust_store_option(wrapped_function)))))
+    return profile_option(trust_store_option(wrapped_function))

{nominal-1.95.0 → nominal-1.96.0}/nominal/core/client.py

@@ -31,7 +31,6 @@ from nominal_api import (
 from typing_extensions import Self, deprecated
 
 from nominal import ts
-from nominal._utils.deprecation_tools import warn_on_deprecated_argument
 from nominal.config import NominalConfig, _config
 from nominal.core._clientsbunch import ClientsBunch
 from nominal.core._constants import DEFAULT_API_BASE_URL
@@ -94,7 +93,7 @@ from nominal.core.dataset import (
 )
 from nominal.core.datasource import DataSource
 from nominal.core.event import Event, EventType
-from nominal.core.exceptions import NominalConfigError, NominalError, NominalIngestError
+from nominal.core.exceptions import NominalConfigError, NominalError, NominalIngestError, NominalMethodRemovedError
 from nominal.core.filetype import FileType, FileTypes
 from nominal.core.run import Run
 from nominal.core.secret import Secret
@@ -338,10 +337,6 @@ class NominalClient:
         for raw_dataset in search_datasets_paginated(self._clients.catalog, self._clients.auth_header, query):
             yield Dataset._from_conjure(self._clients, raw_dataset)
 
-    @warn_on_deprecated_argument(
-        "workspace_rid",
-        "`workspace_rid` has been deprecated and will be removed in a future version. Use `workspace` instead.",
-    )
     def search_datasets(
         self,
         *,
@@ -351,7 +346,6 @@ class NominalClient:
         properties: Mapping[str, str] | None = None,
         before: str | datetime | IntegralNanosecondsUTC | None = None,
         after: str | datetime | IntegralNanosecondsUTC | None = None,
-        workspace_rid: Workspace | str | None = None,
         workspace: WorkspaceSearchT = WorkspaceSearchType.ALL,
         archived: bool | None = None,
     ) -> Sequence[Dataset]:
@@ -365,7 +359,6 @@ class NominalClient:
             properties: A mapping of key-value pairs that must ALL be present on a secret to be included.
             before: Searches for datasets created before some time (inclusive).
             after: Searches for datasets created before after time (inclusive).
-            workspace_rid: deprecated. use `workspace` instead.
             workspace: Filters search to given workspace.
             archived: Filters results to either archived or unarchived datasets.
 
@@ -377,12 +370,6 @@ class NominalClient:
         Returns:
             All datasets which match all of the provided conditions
         """
-        if workspace is not None and workspace_rid is not None:
-            raise ValueError("Both `workspace` and `workspace_rid` provided-- must use one or the other.")
-
-        if workspace_rid is not None:
-            workspace = workspace_rid
-
         query = create_search_datasets_query(
             exact_match=exact_match,
             search_text=search_text,
@@ -1477,7 +1464,7 @@ class NominalClient:
 
     @deprecated(
         "Calling `NominalClient.create_workbook_from_template` is deprecated and will be removed "
-        "in a future release. Use `Template.create_workbook` instead"
+        "in a future release. Use `WorkbookTemplate.create_workbook` instead"
     )
     def create_workbook_from_template(
         self,
@@ -1487,13 +1474,7 @@ class NominalClient:
         description: str | None = None,
         is_draft: bool = False,
     ) -> Workbook:
-        """Creates a workbook from a workbook template.
-
-        NOTE: is_draft is intentionally unused and will be removed in a future release.
-        """
-        template = self.get_workbook_template(template_rid)
-        return template.create_workbook(
-            title=title,
-            description=description,
-            run=run_rid,
+        raise NominalMethodRemovedError(
+            "nominal.core.NominalClient.create_workbook_from_template",
+            "use 'nominal.core.WorkbookTemplate.create_workbook' instead",
         )

{nominal-1.95.0 → nominal-1.96.0}/nominal/core/data_review.py

@@ -21,6 +21,7 @@ from typing_extensions import Self, deprecated
 from nominal.core import checklist, event
 from nominal.core._clientsbunch import HasScoutParams
 from nominal.core._utils.api_tools import HasRid
+from nominal.core.exceptions import NominalMethodRemovedError
 from nominal.ts import IntegralNanosecondsUTC, _SecondsNanos
 
 
@@ -75,8 +76,10 @@ class DataReview(HasRid):
     )
     def get_violations(self) -> Sequence[CheckViolation]:
         """Retrieves the list of check violations for the data review."""
-        response = self._clients.datareview.get_check_alerts_for_data_review(self._clients.auth_header, self.rid)
-        return [CheckViolation._from_conjure(alert) for alert in response]
+        raise NominalMethodRemovedError(
+            "nominal.core.DataReview.get_violations",
+            "use 'nominal.core.DataReview.get_events()' instead",
+        )
 
     def get_events(self) -> Sequence[event.Event]:
         """Retrieves the list of events for the data review."""

{nominal-1.95.0 → nominal-1.96.0}/nominal/core/dataset.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import logging
-import time
 from dataclasses import dataclass
 from datetime import timedelta
 from io import TextIOBase
@@ -20,7 +19,7 @@ from nominal.core.bounds import Bounds
 from nominal.core.containerized_extractors import ContainerizedExtractor
 from nominal.core.dataset_file import DatasetFile
 from nominal.core.datasource import DataSource
-from nominal.core.exceptions import NominalIngestError, NominalIngestFailed, NominalIngestMultiError
+from nominal.core.exceptions import NominalIngestError, NominalIngestMultiError, NominalMethodRemovedError
 from nominal.core.filetype import FileType, FileTypes
 from nominal.core.log import LogPoint, _write_logs
 from nominal.ts import (
@@ -55,38 +54,12 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
         "obtained when ingesting files or by calling `dataset.list_files()`."
     )
     def poll_until_ingestion_completed(self, interval: timedelta = timedelta(seconds=1)) -> Self:
-        """Block until dataset file ingestion has completed.
-        This method polls Nominal for ingest status after uploading a file to a dataset on an interval.
-
-        Raises:
-        ------
-            NominalIngestFailed: if the ingest failed
-            NominalIngestError: if the ingest status is not known
-
-        """
-        while True:
-            progress = self._clients.catalog.get_ingest_progress_v2(self._clients.auth_header, self.rid)
-            if progress.ingest_status.type == "success":
-                break
-            elif progress.ingest_status.type == "inProgress":  # "type" strings are camelCase
-                pass
-            elif progress.ingest_status.type == "error":
-                error = progress.ingest_status.error
-                if error is not None:
-                    raise NominalIngestFailed(
-                        f"ingest failed for dataset {self.rid!r}: {error.message} ({error.error_type})"
-                    )
-                raise NominalIngestError(
-                    f"ingest status type marked as 'error' but with no instance for dataset {self.rid!r}"
-                )
-            else:
-                raise NominalIngestError(
-                    f"unhandled ingest status {progress.ingest_status.type!r} for dataset {self.rid!r}"
-                )
-            time.sleep(interval.total_seconds())
-
-        # Update metadata now that data has successfully ingested
-        return self.refresh()
+        raise NominalMethodRemovedError(
+            "nominal.core.Dataset.poll_until_ingestion_completed",
+            "poll for ingestion completion on individual 'nominal.core.DatasetFile's, "
+            "which are obtained when ingesting files or by calling "
+            "'nominal.core.Dataset.list_files()' etc.",
+        )
 
     def update(
         self,
@@ -339,8 +312,14 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
     def add_ardupilot_dataflash(
         self,
         path: Path | str,
+        tags: Mapping[str, str] | None = None,
     ) -> DatasetFile:
-        """Add a Dataflash file to an existing dataset."""
+        """Add a Dataflash file to an existing dataset.
+
+        Args:
+            path: Path to the Dataflash file to add to this dataset.
+            tags: key-value pairs to apply as tags to all data uniformly in the file.
+        """
         dataflash_path = Path(path)
         s3_path = upload_multipart_file(
             self._clients.auth_header,
@@ -352,7 +331,7 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
         target = ingest_api.DatasetIngestTarget(
             existing=ingest_api.ExistingDatasetIngestDestination(dataset_rid=self.rid)
         )
-        request = _create_dataflash_ingest_request(s3_path, target)
+        request = _create_dataflash_ingest_request(s3_path, target, tags)
         resp = self._clients.ingest.ingest(self._clients.auth_header, request)
         return self._handle_ingest_response(resp)
 
@@ -548,6 +527,10 @@ class Dataset(DataSource, RefreshableMixin[scout_catalog.EnrichedDataset]):
         )
 
 
+@deprecated(
+    "poll_until_ingestion_completed() is deprecated and will be removed in a future release. "
+    "Instead, call poll_until_ingestion_completed() on individual DatasetFiles."
+)
 def poll_until_ingestion_completed(datasets: Iterable[Dataset], interval: timedelta = timedelta(seconds=1)) -> None:
     """Block until all dataset ingestions have completed (succeeded or failed).
 
@@ -562,7 +545,8 @@ def poll_until_ingestion_completed(datasets: Iterable[Dataset], interval: timede
     errors = {}
     for dataset in datasets:
         try:
-            dataset.poll_until_ingestion_completed(interval=interval)
+            for dataset_file in dataset.list_files():
+                dataset_file.poll_until_ingestion_completed(interval=interval)
         except NominalIngestError as e:
             errors[dataset.rid] = e
     if errors:
@@ -611,12 +595,17 @@ def _create_dataset(
     return client.create_dataset(auth_header, request)
 
 
-def _create_dataflash_ingest_request(s3_path: str, target: ingest_api.DatasetIngestTarget) -> ingest_api.IngestRequest:
+def _create_dataflash_ingest_request(
+    s3_path: str,
+    target: ingest_api.DatasetIngestTarget,
+    tags: Mapping[str, str] | None = None,
+) -> ingest_api.IngestRequest:
     return ingest_api.IngestRequest(
         ingest_api.IngestOptions(
             dataflash=ingest_api.DataflashOpts(
                 source=ingest_api.IngestSource(s3=ingest_api.S3IngestSource(path=s3_path)),
                 target=target,
+                additional_file_tags={**tags} if tags else None,
             )
         ),
     )

{nominal-1.95.0 → nominal-1.96.0}/nominal/core/event.py

@@ -7,7 +7,7 @@ from enum import Enum
 from typing import Iterable, Mapping, Protocol, Sequence
 
 from nominal_api import event
-from typing_extensions import Self, deprecated
+from typing_extensions import Self
 
 from nominal.core._clientsbunch import HasScoutParams
 from nominal.core._utils.api_tools import HasRid, RefreshableMixin, rid_from_instance_or_string
@@ -45,11 +45,6 @@ class Event(HasRid, RefreshableMixin[event.Event]):
 
         return resp[0]
 
-    @property
-    @deprecated("The uuid field of an event is deprecated and will be removed in a future release")
-    def uuid(self) -> str:
-        return self._uuid
-
     def update(
         self,
         *,

nominal-1.96.0/nominal/core/exceptions.py

@@ -0,0 +1,78 @@
+from typing import Mapping
+
+
+class NominalError(Exception):
+    """Base class for Nominal exceptions."""
+
+
+class NominalIngestError(NominalError):
+    """An error occurred during ingest."""
+
+
+class NominalIngestMultiError(NominalError):
+    """Error(s) occurred during ingest.
+
+    Attributes:
+    ----------
+        errors: A mapping of dataset RIDs to the errors that occurred during ingest.
+
+    """
+
+    def __init__(self, rids_to_errors: Mapping[str, NominalIngestError]) -> None:
+        """Initialize multi-error with the rids to error on."""
+        self.errors = rids_to_errors
+
+    def __str__(self) -> str:
+        """String repr."""
+        return f"{len(self.errors)} errors occurred during ingest: {self.errors}"
+
+
+class NominalIngestFailed(NominalIngestError):
+    """The ingest failed."""
+
+
+class NominalMultipartUploadFailed(NominalError):
+    """The multipart upload failed."""
+
+
+class NominalConfigError(NominalError):
+    """An error occurred reading or writing the configuration."""
+
+
+class NominalMethodRemovedError(NominalError):
+    """An error raised when a method has been deprecated and now removed.
+    Error informs users of the new method to use instead.
+    """
+
+    def __init__(self, original_method: str, instructions: str | None = None):
+        """Initialize error with the method removed and method to use instead."""
+        self._original_method = original_method
+        self._instructions = instructions
+
+    def __str__(self) -> str:
+        """String repr."""
+        base_msg = f"'{self._original_method}' was deprecated and has now been removed."
+        if self._instructions is None:
+            return f"{base_msg} Contact your Nominal Representative if you need this functionality."
+        else:
+            return f"{base_msg} To fix: {self._instructions}"
+
+
+class NominalParameterRemovedError(NominalError):
+    """An error raised when an parameter has been deprecated and now removed."""
+
+    def __init__(self, method_name: str, parameter_name: str, instructions: str | None = None):
+        """Initialize error with the method removed and method to use instead."""
+        self._method_name = method_name
+        self._parameter_name = parameter_name
+        self._instructions = instructions
+
+    def __str__(self) -> str:
+        """String repr."""
+        base_msg = (
+            f"Parameter '{self._parameter_name}' was deprecated and has now been removed from '{self._method_name}'."
+        )
+        if self._instructions is None:
+            return f"{base_msg} Contact your Nominal Representative if you need this functionality."
+        else:
+            return f"{base_msg} To fix: {self._instructions}"