nextmv 0.27.0__tar.gz → 0.28.1.dev0__tar.gz

{nextmv-0.27.0 → nextmv-0.28.1.dev0}/.gitignore

@@ -161,3 +161,6 @@ cython_debug/
 
 # VSCode
 .vscode/
+
+# Documentation stuff
+site/

{nextmv-0.27.0 → nextmv-0.28.1.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 0.27.0
+Version: 0.28.1.dev0
 Summary: The all-purpose Python SDK for Nextmv
 Project-URL: Homepage, https://www.nextmv.io
 Project-URL: Documentation, https://www.nextmv.io/docs/python-sdks/nextmv/installation
@@ -229,8 +229,28 @@ Description-Content-Type: text/markdown
 
 # Nextmv Python SDK
 
-Welcome to `nextmv`, the general Python SDK for the Nextmv Platform. To learn
-more about `nextmv`, visit the [docs][docs].
+<!-- markdownlint-disable MD033 MD013 -->
+
+<p align="center">
+  <a href="https://nextmv.io"><img src="https://cdn.prod.website-files.com/60dee0fad10d14c8ab66dd74/674628a824bc14307c1727aa_blog-prototype-p-2000.png" alt="Nextmv" width="45%"></a>
+</p>
+<p align="center">
+    <em>Nextmv: The home for all your optimization work</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/nextmv" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/nextmv.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+<a href="https://pypi.org/project/nextmv" target="_blank">
+    <img src="https://img.shields.io/pypi/v/nextmv?color=%2334D058&label=nextmv" alt="Package version">
+</a>
+</p>
+
+<!-- markdownlint-enable MD033 MD013 -->
+
+Welcome to `nextmv`, the general Python SDK for the Nextmv Platform.
+
+📖 To learn more about the `nextmv`, visit the [docs][docs].
 
 ## Installation
 
@@ -246,4 +266,4 @@ Install all optional dependencies (recommended):
 pip install "nextmv[all]"
 ```
 
-[docs]: https://nextmv.io/docs/python-sdks/nextmv/installation
+[docs]: https://nextmv-py.readthedocs.io/en/latest/nextmv/

nextmv-0.28.1.dev0/README.md

@@ -0,0 +1,40 @@
+# Nextmv Python SDK
+
+<!-- markdownlint-disable MD033 MD013 -->
+
+<p align="center">
+  <a href="https://nextmv.io"><img src="https://cdn.prod.website-files.com/60dee0fad10d14c8ab66dd74/674628a824bc14307c1727aa_blog-prototype-p-2000.png" alt="Nextmv" width="45%"></a>
+</p>
+<p align="center">
+    <em>Nextmv: The home for all your optimization work</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/nextmv" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/nextmv.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+<a href="https://pypi.org/project/nextmv" target="_blank">
+    <img src="https://img.shields.io/pypi/v/nextmv?color=%2334D058&label=nextmv" alt="Package version">
+</a>
+</p>
+
+<!-- markdownlint-enable MD033 MD013 -->
+
+Welcome to `nextmv`, the general Python SDK for the Nextmv Platform.
+
+📖 To learn more about the `nextmv`, visit the [docs][docs].
+
+## Installation
+
+Requires Python `>=3.9`. Install using `pip`:
+
+```bash
+pip install nextmv
+```
+
+Install all optional dependencies (recommended):
+
+```bash
+pip install "nextmv[all]"
+```
+
+[docs]: https://nextmv-py.readthedocs.io/en/latest/nextmv/

nextmv-0.28.1.dev0/nextmv/__about__.py

@@ -0,0 +1 @@
+__version__ = "v0.28.1.dev0"

{nextmv-0.27.0 → nextmv-0.28.1.dev0}/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-0.28.1.dev0/nextmv/base_model.py

@@ -0,0 +1,90 @@
+"""
+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 as PydanticBaseModel
+
+
+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):
+        """
+        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
+
+        return cls(**data)
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        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.
+
+    Parameters
+    ----------
+    data : dict[str, Any]
+        The data to load.
+
+    Returns
+    -------
+    Any
+        The loaded data model instance.
+    """
+
+    module = import_module(data["class"]["module"])
+    cls = getattr(module, data["class"]["name"])
+
+    return cls.from_dict(data["attributes"])

{nextmv-0.27.0 → nextmv-0.28.1.dev0}/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