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

nextmv/{cloud/safe.py → safe.py}

@@ -1,5 +1,15 @@
 """
-Utilities for generating “safe” IDs and huma-readable names
+
+The safe module contains utilities for generating “safe” IDs and human-readable
+names.
+
+Functions
+---------
+safe_name_and_id
+    Generate a safe ID and human-readable name from a prefix and user-supplied
+    identifier.
+safe_id
+    Generate a safe ID from a prefix.
 """
 
 import re
@@ -31,11 +41,17 @@ def _nanoid(size: int = 8, alphabet: str = string.ascii_lowercase + string.digit
     return "".join(secrets.choice(alphabet) for _ in range(size))
 
 
-def _name_and_id(prefix: str, entity_id: str) -> tuple[str, str]:
+def safe_name_and_id(prefix: str, entity_id: str) -> tuple[str, str]:
     """
     Generate a safe ID and human-readable name from a prefix and user-supplied
     identifier.
 
+    You can import the `safe_name_and_id` function directly from `nextmv`:
+
+    ```python
+    from nextmv import safe_name_and_id
+    ```
+
     Parameters
     ----------
     prefix : str
@@ -48,6 +64,11 @@ def _name_and_id(prefix: str, entity_id: str) -> tuple[str, str]:
     -------
     tuple[str, str]
         A tuple containing the human-readable name and the safe ID.
+
+    Examples
+    --------
+    >>> safe_name_and_id("app", "My Application 123!")
+    ('App My Application 123', 'app-my-application-123-4f5g6h7j')
     """
 
     if not prefix or not entity_id:
@@ -83,10 +104,16 @@ def _name_and_id(prefix: str, entity_id: str) -> tuple[str, str]:
     return safe_name, safe_id
 
 
-def _safe_id(prefix: str) -> str:
+def safe_id(prefix: str) -> str:
     """
     Generate a safe ID from a prefix.
 
+    You can import the `safe_id` function directly from `nextmv`:
+
+    ```python
+    from nextmv import safe_id
+    ```
+
     Parameters
     ----------
     prefix : str
@@ -96,6 +123,11 @@ def _safe_id(prefix: str) -> str:
     -------
     str
         A safe ID.
+
+    Examples
+    --------
+    >>> safe_id("app")
+    'app-4f5g6h7j'
     """
 
     random_slug = _nanoid(8)

nextmv/{cloud/status.py → status.py}

@@ -1,9 +1,9 @@
 """
-Provides status enums for Nextmv Cloud runs.
+Provides status enums for Nextmv application runs.
 
-This module defines enumerations for representing the status of a run in
-Nextmv Cloud. It includes a deprecated `Status` enum and the current `StatusV2`
-enum.
+This module defines enumerations for representing the status of a run in a
+Nextmv application. It includes a deprecated `Status` enum and the current
+`StatusV2` enum.
 
 Classes
 -------
@@ -23,10 +23,10 @@ class Status(str, Enum):
 
     Status of a run.
 
-    You can import the `Status` class directly from `cloud`:
+    You can import the `Status` class directly from `nextmv`:
 
     ```python
-    from nextmv.cloud import Status
+    from nextmv import Status
     ```
 
     This enum represents the possible states of a run. It is deprecated and
@@ -67,14 +67,14 @@ class StatusV2(str, Enum):
     """
     Status of a run.
 
-    You can import the `StatusV2` class directly from `cloud`:
+    You can import the `StatusV2` class directly from `nextmv`:
 
     ```python
-    from nextmv.cloud import StatusV2
+    from nextmv import StatusV2
     ```
 
     This enum represents the comprehensive set of possible states for a run
-    in Nextmv Cloud.
+    in Nextmv.
 
     Attributes
     ----------

{nextmv-0.29.5.dev1.dist-info → nextmv-0.31.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 0.29.5.dev1
+Version: 0.31.0
 Summary: The all-purpose Python SDK for Nextmv
 Project-URL: Homepage, https://www.nextmv.io
 Project-URL: Documentation, https://nextmv-py.docs.nextmv.io/en/latest/nextmv/
@@ -224,13 +224,17 @@ Requires-Dist: pyyaml>=6.0.1
 Requires-Dist: requests>=2.31.0
 Requires-Dist: urllib3>=2.1.0
 Provides-Extra: all
+Requires-Dist: folium>=0.20.0; extra == 'all'
 Requires-Dist: mlflow>=2.17.2; extra == 'all'
+Requires-Dist: plotly>=6.0.1; extra == 'all'
 Provides-Extra: dev
 Requires-Dist: build>=1.0.3; extra == 'dev'
+Requires-Dist: folium>=0.20.0; extra == 'dev'
 Requires-Dist: mlflow>=2.19.0; extra == 'dev'
 Requires-Dist: nextroute>=1.11.1; extra == 'dev'
 Requires-Dist: openpyxl>=3.1.5; extra == 'dev'
 Requires-Dist: pandas>=2.2.3; extra == 'dev'
+Requires-Dist: plotly>=6.0.1; extra == 'dev'
 Requires-Dist: pydantic>=2.5.2; extra == 'dev'
 Requires-Dist: pyyaml>=6.0.1; extra == 'dev'
 Requires-Dist: requests>=2.31.0; extra == 'dev'

nextmv-0.31.0.dist-info/RECORD

@@ -0,0 +1,46 @@
+nextmv/__about__.py,sha256=i5eBaiSsNePRIiANLGw8JNVRypZK2clr6sonwFiA8Bk,24
+nextmv/__entrypoint__.py,sha256=dA0iwwHtrq6Z9w9FxmxKLoBGLyhe7jWtUAU-Y3PEgHg,1094
+nextmv/__init__.py,sha256=tKJua9rvXDBMSN_PfpL3uuv2bISb_e5-ROWZRmnWnzk,3885
+nextmv/_serialization.py,sha256=JlSl6BL0M2Esf7F89GsGIZ__Pp8RnFRNM0UxYhuuYU4,2853
+nextmv/base_model.py,sha256=qmJ4AsYr9Yv01HQX_BERrn3229gyoZrYyP9tcyqNfeU,2311
+nextmv/deprecated.py,sha256=kEVfyQ-nT0v2ePXTNldjQG9uH5IlfQVy3L4tztIxwmU,1638
+nextmv/input.py,sha256=EMwfTt8vsw-yBI6dNnTJpK2c6jhI6OefATY0t69P7FI,40384
+nextmv/logger.py,sha256=kNIbu46MisrzYe4T0hNMpWfRTKKacDVvbtQcNys_c_E,2513
+nextmv/manifest.py,sha256=wzGDrGleIgYvRvKyy73acjd68cGdCLD_7x_Dy3UhCaI,44266
+nextmv/model.py,sha256=vI3pSV3iTwjRPflar7nAg-6h98XRUyi9II5O2J06-Kc,15018
+nextmv/options.py,sha256=yPJu5lYMbV6YioMwAXv7ctpZUggLXKlZc9CqIbUFvE4,37895
+nextmv/output.py,sha256=d1CSaeVWTR6go1kKmx4VHgIPhK7McI9-aFxoga-Rjvg,55625
+nextmv/polling.py,sha256=nfefvWI1smm-lIzaXE-4DMlojp6KXIvVi88XLJYUmo8,9724
+nextmv/run.py,sha256=rjHP7RzNkEKMucti3rCY9vi2UOVEEHSz0d_OqTYFRHY,34257
+nextmv/safe.py,sha256=VAK4fGEurbLNji4Pg5Okga5XQSbI4aI9JJf95_68Z20,3867
+nextmv/status.py,sha256=SCDLhh2om3yeO5FxO0x-_RShQsZNXEpjHNdCGdb3VUI,2787
+nextmv/cloud/__init__.py,sha256=5B2aMKffI_WSFlVlT-oO7ISMqxJeN9XEoqmy7ghKmOI,4651
+nextmv/cloud/acceptance_test.py,sha256=1IQ2w7Imu_NAKknLQYNIIV9i_XIf8tmNHVTAOBEtsU8,25675
+nextmv/cloud/account.py,sha256=jIdGNyI3l3dVh2PuriAwAOrEuWRM150WgzxcBMVBNRw,6058
+nextmv/cloud/application.py,sha256=Vx8EZvuXfKQK9GztGXEMicA4OP0cxn_jWTOvOx0k4hE,134099
+nextmv/cloud/batch_experiment.py,sha256=UQBPX9YwPlaNh8wnI-HTj5VVwK164bfPTElTRy3fdng,10182
+nextmv/cloud/client.py,sha256=E0DiUb377jvEnpXlRnfT1PGCI0Jm0lTUoX5VqeU91lk,18165
+nextmv/cloud/input_set.py,sha256=NkzA6_hwgD-YwoirzwvZrObIoBTfurry7Os3jo4DyXc,4236
+nextmv/cloud/instance.py,sha256=SS4tbp0LQMWDaeYpwcNxJei82oi_Hozv1t5i3QGjASY,4024
+nextmv/cloud/package.py,sha256=cG75DptN4sxXaT8ruDh2EY2duaK5Jwg16X2LV0BP8ts,13021
+nextmv/cloud/scenario.py,sha256=JRFTDiFBcrgud6wE2qDHUu5oO-Ur3zbPYhhB6ONCxTo,14263
+nextmv/cloud/secrets.py,sha256=fA5cX0jfTsPVZWV7433wzETGlXpWRLHGswuObx9e6FQ,6820
+nextmv/cloud/url.py,sha256=Fz70ywkWdCLmP21ZBmJwZi5kDbjpmsX_VlwVF_xQeHg,1836
+nextmv/cloud/version.py,sha256=5_S7_pWUVBFbvAArku20eK7S645GJcHtgE2OpXLdSzQ,5300
+nextmv/default_app/.gitignore,sha256=gsfnfXMYNt-YTroh5hAzauwBZoPDJ6D_fB17rMSnIko,8
+nextmv/default_app/README.md,sha256=zY9iXhqQM4Kan9XnTHoQrBMArXfD6d-k1z-MBle8yxs,451
+nextmv/default_app/app.yaml,sha256=DnUN78PxzVsyppSwGQhr8iJLKqdMiCcjIzzTZhzz9S8,395
+nextmv/default_app/requirements.txt,sha256=wRE_HkYYWzCGnYZ2NuatHXul4gCHvU3iUAdsxtzpYiA,29
+nextmv/default_app/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nextmv/default_app/src/main.py,sha256=WWeN_xl_mcPhICl3rSCvdEjRkFXGmAnej88FhS-fAmc,884
+nextmv/default_app/src/visuals.py,sha256=WYK_YBnLmYo3TpVev1CpoNCuW5R7hk9QIkeCmvMn1Fs,1014
+nextmv/local/__init__.py,sha256=6BsoqlK4dw6X11_uKzz9gBPfxKpdiol2FYO8R3X73SE,116
+nextmv/local/application.py,sha256=n3nu4T_vwJiMUeCqmeFpe-925fd5208vDk46QffOjCI,45194
+nextmv/local/executor.py,sha256=NaNC70Cgv42Mpcbr6woAf4fcGpgxE3FnYvDAAdhntUI,24329
+nextmv/local/geojson_handler.py,sha256=7FavJdkUonop-yskjis0x3qFGB8A5wZyoBUblw-bVhw,12540
+nextmv/local/plotly_handler.py,sha256=bLb50e3AkVr_W-F6S7lXfeRdN60mG2jk3UElNmhoMWU,1930
+nextmv/local/runner.py,sha256=SH1XR0JpxdMiFfUiYZ3io_I65N4uTgOAtEAQ1mwQFP8,9753
+nextmv-0.31.0.dist-info/METADATA,sha256=RMGw8a13Zbt93dzblapt8q1Mw7zPoFBN1d3NkpNrGB4,16008
+nextmv-0.31.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nextmv-0.31.0.dist-info/licenses/LICENSE,sha256=ZIbK-sSWA-OZprjNbmJAglYRtl5_K4l9UwAV3PGJAPc,11349
+nextmv-0.31.0.dist-info/RECORD,,

nextmv-0.29.5.dev1.dist-info/RECORD

@@ -1,37 +0,0 @@
-nextmv/__about__.py,sha256=1SVbu68wEsLoHV7PnoKLzsYP7hPdn2-2Yx0-mN6ohaI,30
-nextmv/__entrypoint__.py,sha256=dA0iwwHtrq6Z9w9FxmxKLoBGLyhe7jWtUAU-Y3PEgHg,1094
-nextmv/__init__.py,sha256=FsF0pEkOSBuPY5EKu7NsBxro7jswGmOmaw61kZEudXY,1930
-nextmv/_serialization.py,sha256=JlSl6BL0M2Esf7F89GsGIZ__Pp8RnFRNM0UxYhuuYU4,2853
-nextmv/base_model.py,sha256=qmJ4AsYr9Yv01HQX_BERrn3229gyoZrYyP9tcyqNfeU,2311
-nextmv/deprecated.py,sha256=kEVfyQ-nT0v2ePXTNldjQG9uH5IlfQVy3L4tztIxwmU,1638
-nextmv/input.py,sha256=iTMIdhSi4H-Xot44CYaUH110WDcpWDsJ5JXxSMGIZaY,40030
-nextmv/logger.py,sha256=kNIbu46MisrzYe4T0hNMpWfRTKKacDVvbtQcNys_c_E,2513
-nextmv/model.py,sha256=vI3pSV3iTwjRPflar7nAg-6h98XRUyi9II5O2J06-Kc,15018
-nextmv/options.py,sha256=yPJu5lYMbV6YioMwAXv7ctpZUggLXKlZc9CqIbUFvE4,37895
-nextmv/output.py,sha256=vcBqtP1hJLYyUvfk_vl1Ejbk3q5KxOmlTz4Lnqqnyd0,54141
-nextmv/cloud/__init__.py,sha256=cGRkIcn1evTdgw7lEH2k4MPTZnq37XIF3ovbuDjUWGI,3914
-nextmv/cloud/acceptance_test.py,sha256=Bcfdmh2fkPeBx8FDCngeUo2fjV_LhsUdygnzDQCDbYY,26898
-nextmv/cloud/account.py,sha256=eukiYQha4U2fkIjg4SgdoawKE1kU5G7GPyDJVrn8hHA,6064
-nextmv/cloud/application.py,sha256=oyeXLUemFGRU3cPu0B3_WTtpzvAch5vR3Mo4gswohKs,130627
-nextmv/cloud/batch_experiment.py,sha256=Rmcwe1uAVz2kRrAMQqLYC5d__L_IqPXbF__RE3uQTAY,8196
-nextmv/cloud/client.py,sha256=E0DiUb377jvEnpXlRnfT1PGCI0Jm0lTUoX5VqeU91lk,18165
-nextmv/cloud/input_set.py,sha256=2dqmf5z-rZjTKwtBRvnUdfPfKv28It5uTCX0C70uP4Y,4242
-nextmv/cloud/instance.py,sha256=SS4tbp0LQMWDaeYpwcNxJei82oi_Hozv1t5i3QGjASY,4024
-nextmv/cloud/manifest.py,sha256=5FqXtT1q7qmyQxqB5rG33y97WFZ6erL1f9kRel575RQ,37456
-nextmv/cloud/package.py,sha256=f0OjdlIOsI2LpmgSxdFf6YaA8Ucs9yAm_3bO0Cp8LH4,13027
-nextmv/cloud/run.py,sha256=-I1S5fLIFLH1P9xViv5bOS2LbO9-w6tnB8cBGU0_yTo,22743
-nextmv/cloud/safe.py,sha256=hWh_quD2KSazTV5SOAddOsFLsY4oWBzajOUcCeHOjc8,3180
-nextmv/cloud/scenario.py,sha256=JRFTDiFBcrgud6wE2qDHUu5oO-Ur3zbPYhhB6ONCxTo,14263
-nextmv/cloud/secrets.py,sha256=fA5cX0jfTsPVZWV7433wzETGlXpWRLHGswuObx9e6FQ,6820
-nextmv/cloud/status.py,sha256=blvykRCTCTBkaqH88j4dzdQLhU2v1Ig62-_va98zw20,2789
-nextmv/cloud/version.py,sha256=5_S7_pWUVBFbvAArku20eK7S645GJcHtgE2OpXLdSzQ,5300
-nextmv/default_app/README.md,sha256=zY9iXhqQM4Kan9XnTHoQrBMArXfD6d-k1z-MBle8yxs,451
-nextmv/default_app/app.yaml,sha256=USfr6K4YkIC9VEw-ExlNIZKxkZf6beBu1YW6pWIzF2o,370
-nextmv/default_app/requirements.txt,sha256=wRE_HkYYWzCGnYZ2NuatHXul4gCHvU3iUAdsxtzpYiA,29
-nextmv/default_app/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nextmv/default_app/src/main.py,sha256=HlO8UwZbZYiAQyrZDSR_T4NBcwP1gIjdTdwkJP_dn8I,847
-nextmv/default_app/src/visuals.py,sha256=WYK_YBnLmYo3TpVev1CpoNCuW5R7hk9QIkeCmvMn1Fs,1014
-nextmv-0.29.5.dev1.dist-info/METADATA,sha256=ZjPhAMSjNH140opVHGm7ifWCR6hND8LGfYm1xH5bhCU,15831
-nextmv-0.29.5.dev1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nextmv-0.29.5.dev1.dist-info/licenses/LICENSE,sha256=ZIbK-sSWA-OZprjNbmJAglYRtl5_K4l9UwAV3PGJAPc,11349
-nextmv-0.29.5.dev1.dist-info/RECORD,,