nextmv 0.27.0__py3-none-any.whl → 0.28.1__py3-none-any.whl

nextmv/__about__.py

@@ -1 +1 @@
-__version__ = "v0.27.0"
+__version__ = "v0.28.1"

nextmv/__init__.py

@@ -1,6 +1,7 @@
 """Nextmv Python SDK."""
 
 from .__about__ import __version__
+from .base_model import BaseModel as BaseModel
 from .base_model import from_dict as from_dict
 from .input import Input as Input
 from .input import InputFormat as InputFormat

nextmv/base_model.py

@@ -1,17 +1,52 @@
-"""JSON class for data wrangling JSON objects."""
+"""
+Provides base functionality for handling JSON data in models.
+
+This module contains utilities for converting between dictionaries and model
+instances, facilitating data serialization and deserialization.
+
+Classes
+-------
+BaseModel:
+    A base class extending Pydantic's BaseModel with additional methods for
+    JSON data serialization and deserialization.
+
+Functions
+---------
+from_dict:
+    Load a data model instance from a dictionary containing class information
+    and attributes.
+"""
 
 from importlib import import_module
 from typing import Any, Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel as PydanticBaseModel
 
 
-class BaseModel(BaseModel):
-    """Base class for data wrangling tasks with JSON."""
+class BaseModel(PydanticBaseModel):
+    """
+    Base class for data wrangling tasks with JSON.
+
+    This class extends Pydantic's `BaseModel` to provide additional methods
+    for converting between Python objects and JSON/dictionary representations.
+    """
 
     @classmethod
     def from_dict(cls, data: Optional[dict[str, Any]] = None):
-        """Instantiates the class from a dict."""
+        """
+        Instantiate the class from a dictionary.
+
+        Parameters
+        ----------
+        data : dict[str, Any], optional
+            The dictionary containing the data to instantiate the class.
+            If None, returns None.
+
+        Returns
+        -------
+        cls or None
+            An instance of the class with the given data or None if data is None.
+        """
 
         if data is None:
             return None
@@ -19,14 +54,24 @@ class BaseModel(BaseModel):
         return cls(**data)
 
     def to_dict(self) -> dict[str, Any]:
-        """Converts the class to a dict."""
+        """
+        Convert the class instance to a dictionary.
+
+        The conversion uses Pydantic's model_dump method, excluding None values
+        and using field aliases if defined.
+
+        Returns
+        -------
+        dict[str, Any]
+            Dictionary representation of the class instance.
+        """
 
         return self.model_dump(mode="json", exclude_none=True, by_alias=True)
 
 
 def from_dict(data: dict[str, Any]) -> Any:
     """
-    Load a data model instance from a dict with associated class info.
+    Load a data model instance from a `dict` with associated class info.
 
     Parameters
     ----------

nextmv/cloud/__init__.py

@@ -23,15 +23,18 @@ from .application import Application as Application
 from .application import DownloadURL as DownloadURL
 from .application import PollingOptions as PollingOptions
 from .application import UploadURL as UploadURL
+from .application import poll as poll
 from .batch_experiment import BatchExperiment as BatchExperiment
 from .batch_experiment import BatchExperimentInformation as BatchExperimentInformation
 from .batch_experiment import BatchExperimentMetadata as BatchExperimentMetadata
 from .batch_experiment import BatchExperimentRun as BatchExperimentRun
 from .client import Client as Client
+from .client import get_size as get_size
 from .input_set import InputSet as InputSet
 from .input_set import ManagedInput as ManagedInput
 from .instance import Instance as Instance
 from .instance import InstanceConfiguration as InstanceConfiguration
+from .manifest import MANIFEST_FILE_NAME as MANIFEST_FILE_NAME
 from .manifest import Manifest as Manifest
 from .manifest import ManifestBuild as ManifestBuild
 from .manifest import ManifestOption as ManifestOption