nextmv 0.29.5.dev1__py3-none-any.whl → 0.31.0__py3-none-any.whl

nextmv/cloud/batch_experiment.py

@@ -3,6 +3,8 @@ This module contains definitions for batch experiments.
 
 Classes
 -------
+ExperimentStatus
+    Enum representing the status of an experiment.
 BatchExperimentInformation
     Base class for all batch experiment models containing common information.
 BatchExperiment
@@ -14,12 +16,82 @@ BatchExperimentMetadata
 """
 
 from datetime import datetime
+from enum import Enum
 from typing import Any, Optional
 
 from nextmv.base_model import BaseModel
 from nextmv.cloud.input_set import InputSet
 
 
+class ExperimentStatus(str, Enum):
+    """
+    Status of an experiment.
+
+    You can import the `ExperimentStatus` class directly from `cloud`:
+
+    ```python from nextmv.cloud import ExperimentStatus ```
+
+    This enum represents the comprehensive set of possible states for an
+    experiment in Nextmv Cloud.
+
+    Attributes
+    ----------
+    STARTED : str
+        Experiment started.
+    COMPLETED : str
+        Experiment completed.
+    FAILED : str
+        Experiment failed.
+    DRAFT : str
+        Experiment is a draft.
+    CANCELED : str
+        Experiment was canceled.
+    STOPPING : str
+        Experiment is stopping.
+    DELETING : str
+        Experiment is being deleted.
+    DELETE_FAILED : str
+        Experiment deletion failed.
+    UNKNOWN : str
+        Experiment status is unknown.
+
+    Examples
+    --------
+    >>> from nextmv.cloud import ExperimentStatus
+    >>> status = ExperimentStatus.STARTED
+    >>> print(f"The status is: {status.value}")
+    The status is: started
+
+    >>> if status == ExperimentStatus.COMPLETED:
+    ...     print("Processing complete.")
+    ... elif status in [ExperimentStatus.STARTED, ExperimentStatus.STOPPING]:
+    ...     print("Processing in progress.")
+    ... else:
+    ...     print("Processing has not started or has ended with issues.")
+    Processing in progress.
+
+    """
+
+    STARTED = "started"
+    """Experiment started."""
+    COMPLETED = "completed"
+    """Experiment completed."""
+    FAILED = "failed"
+    """Experiment failed."""
+    DRAFT = "draft"
+    """Experiment is a draft."""
+    CANCELED = "canceled"
+    """Experiment was canceled."""
+    STOPPING = "stopping"
+    """Experiment is stopping."""
+    DELETING = "deleting"
+    """Experiment is being deleted."""
+    DELETE_FAILED = "delete-failed"
+    """Experiment deletion failed."""
+    UNKNOWN = "unknown"
+    """Experiment status is unknown."""
+
+
 class BatchExperimentInformation(BaseModel):
     """Information about a batch experiment.
 
@@ -83,7 +155,7 @@ class BatchExperimentInformation(BaseModel):
     updated_at: datetime
     """Last update date of the batch experiment."""
 
-    status: Optional[str] = None
+    status: Optional[ExperimentStatus] = None
     """Status of the batch experiment."""
     description: Optional[str] = None
     """Description of the batch experiment."""

nextmv/cloud/input_set.py

@@ -14,7 +14,7 @@ from datetime import datetime
 from typing import Optional
 
 from nextmv.base_model import BaseModel
-from nextmv.cloud.run import Format
+from nextmv.run import Format
 
 
 class ManagedInput(BaseModel):

nextmv/cloud/package.py

@@ -10,8 +10,8 @@ import tarfile
 import tempfile
 from typing import Optional
 
-from nextmv.cloud.manifest import MANIFEST_FILE_NAME, Manifest, ManifestBuild, ManifestType
 from nextmv.logger import log
+from nextmv.manifest import MANIFEST_FILE_NAME, Manifest, ManifestBuild, ManifestType
 from nextmv.model import Model, ModelConfiguration, _cleanup_python_model
 
 _MANDATORY_FILES_PER_TYPE = {

nextmv/cloud/url.py

@@ -0,0 +1,73 @@
+"""
+Module for declarations related to upload and download URLs in Nextmv Cloud.
+
+Classes
+-------
+DownloadURL
+    Represents a download URL for fetching content from Nextmv Cloud.
+UploadURL
+    Represents an upload URL for sending content to Nextmv Cloud.
+"""
+
+from nextmv.base_model import BaseModel
+
+
+class DownloadURL(BaseModel):
+    """
+    Result of getting a download URL.
+
+    You can import the `DownloadURL` class directly from `cloud`:
+
+    ```python
+    from nextmv.cloud import DownloadURL
+    ```
+
+    This class represents a download URL that can be used to fetch content
+    from Nextmv Cloud, typically used for downloading large run results.
+
+    Attributes
+    ----------
+    url : str
+        URL to use for downloading the file.
+
+    Examples
+    --------
+    >>> download_url = DownloadURL(url="https://example.com/download")
+    >>> response = requests.get(download_url.url)
+    """
+
+    url: str
+    """URL to use for downloading the file."""
+
+
+class UploadURL(BaseModel):
+    """
+    Result of getting an upload URL.
+
+    You can import the `UploadURL` class directly from `cloud`:
+
+    ```python
+    from nextmv.cloud import UploadURL
+    ```
+
+    This class represents an upload URL that can be used to send data to
+    Nextmv Cloud, typically used for uploading large inputs for runs.
+
+    Attributes
+    ----------
+    upload_id : str
+        ID of the upload, used to reference the uploaded content.
+    upload_url : str
+        URL to use for uploading the file.
+
+    Examples
+    --------
+    >>> upload_url = UploadURL(upload_id="123", upload_url="https://example.com/upload")
+    >>> with open("large_input.json", "rb") as f:
+    ...     requests.put(upload_url.upload_url, data=f)
+    """
+
+    upload_id: str
+    """ID of the upload."""
+    upload_url: str
+    """URL to use for uploading the file."""

nextmv/default_app/.gitignore

@@ -0,0 +1 @@
+.nextmv

nextmv/default_app/app.yaml

@@ -9,3 +9,5 @@ python:
 # (e.g.: configs/*.json) is supported.
 files:
   - src/
+
+entrypoint: src/main.py

nextmv/default_app/src/main.py

@@ -24,7 +24,8 @@ assets = create_visuals(name, input.data["radius"], input.data["distance"])
 
 # Write output and statistics.
 output = nextmv.Output(
-    solution=None,
+    options=options,
+    solution={"message": message},
     statistics=nextmv.Statistics(
         result=nextmv.ResultStatistics(
             value=1.23,

nextmv/input.py

@@ -20,6 +20,13 @@ Functions
 ---------
 load
     Load input data using a specified loader.
+
+Constants
+---------
+INPUTS_KEY : str
+    Key used for identifying inputs in the run.
+DEFAULT_INPUT_JSON_FILE : str
+    Constant for the default input JSON file name.
 """
 
 import copy
@@ -36,6 +43,15 @@ from nextmv._serialization import serialize_json
 from nextmv.deprecated import deprecated
 from nextmv.options import Options
 
+INPUTS_KEY = "inputs"
+"""
+Inputs key constant used for identifying inputs in the run.
+"""
+DEFAULT_INPUT_JSON_FILE = "input.json"
+"""
+Constant for the default input JSON file name.
+"""
+
 
 class InputFormat(str, Enum):
     """
@@ -911,7 +927,7 @@ class LocalInputLoader(InputLoader):
             If the path is not a directory or the default directory doesn't exist.
         """
 
-        dir_path = "inputs"
+        dir_path = INPUTS_KEY
         if path is not None and path != "":
             if not os.path.isdir(path):
                 raise ValueError(f"path {path} is not a directory")

nextmv/local/__init__.py

@@ -0,0 +1,5 @@
+"""
+Functionality for locally simulating the Nextmv Cloud.
+"""
+
+from .application import Application as Application