nextmv 0.18.0__py3-none-any.whl → 1.0.0.dev2__py3-none-any.whl

nextmv/safe.py

@@ -0,0 +1,145 @@
+"""
+
+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
+import secrets
+import string
+
+ENTITY_ID_CHAR_COUNT_MAX: int = 40
+INDEX_TAG_CHAR_COUNT: int = 3  # room reserved for “-001”, “-xyz”, etc.
+RE_NON_ALNUM = re.compile(r"[^A-Za-z0-9]+")
+
+
+def _kebab_case(value: str) -> str:
+    """Convert arbitrary text to `kebab-case` (lower-case, hyphen-separated)."""
+
+    cleaned = RE_NON_ALNUM.sub(" ", value).strip()
+    return "-".join(word.lower() for word in cleaned.split())
+
+
+def _start_case(value: str) -> str:
+    """Convert `kebab-case` (or any hyphen/underscore string) to `Start Case`."""
+
+    cleaned = re.sub(r"[-_]+", " ", value)
+    return " ".join(word.capitalize() for word in cleaned.split())
+
+
+def _nanoid(size: int = 8, alphabet: str = string.ascii_lowercase + string.digits) -> str:
+    """Simple nanoid clone using the std-lib `secrets` module."""
+
+    return "".join(secrets.choice(alphabet) for _ in range(size))
+
+
+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
+        Prefix to use for the ID.
+    entity_id : str
+        User-supplied identifier. This will be converted to `kebab-case` and
+        truncated to fit within the safe ID length.
+
+    Returns
+    -------
+    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:
+        return "", ""
+
+    safe_user_defined_id = _kebab_case(entity_id)
+    random_slug = _nanoid(8)
+
+    # Space available for user text once prefix, random slug and separator "-"
+    # are accounted for
+    safe_id_max = (
+        ENTITY_ID_CHAR_COUNT_MAX
+        - INDEX_TAG_CHAR_COUNT
+        - len(prefix)
+        - (len(random_slug) + 1)  # +1 for the hyphen before the slug
+    )
+
+    safe_id_parts: list[str] = [prefix]
+
+    for word in safe_user_defined_id.split("-"):
+        # Trim individual word if it alone would overflow
+        safe_slug = word[: safe_id_max - 1] if len(word) > safe_id_max else word
+
+        # Will the combined ID (so far) overflow if we add this slug?
+        prospective_len = len("-".join(safe_id_parts + [safe_slug]))
+        if prospective_len >= safe_id_max:
+            break
+        safe_id_parts.append(safe_slug)
+
+    safe_id = "-".join(filter(None, safe_id_parts)) + f"-{random_slug}"
+    safe_name = _start_case(safe_id)
+
+    return safe_name, safe_id
+
+
+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
+        Prefix to use for the ID.
+
+    Returns
+    -------
+    str
+        A safe ID.
+
+    Examples
+    --------
+    >>> safe_id("app")
+    'app-4f5g6h7j'
+    """
+
+    random_slug = _nanoid(8)
+    # Space available for user text once prefix, random slug and separator "-"
+    # are accounted for
+    safe_id_max = (
+        ENTITY_ID_CHAR_COUNT_MAX - INDEX_TAG_CHAR_COUNT - (len(random_slug) + 1)  # +1 for the hyphen before the slug
+    )
+
+    if len(prefix) > safe_id_max:
+        return prefix[: safe_id_max - 1] + f"-{random_slug}"
+
+    safe_id = f"{prefix}-{random_slug}"
+
+    return safe_id

nextmv/status.py

@@ -0,0 +1,122 @@
+"""
+Provides status enums for Nextmv application runs.
+
+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
+-------
+Status
+    Deprecated status of a run.
+StatusV2
+    Represents the status of a run.
+"""
+
+from enum import Enum
+
+
+class Status(str, Enum):
+    """
+    !!! warning
+        `Status` is deprecated, use `StatusV2` instead.
+
+    Status of a run.
+
+    You can import the `Status` class directly from `nextmv`:
+
+    ```python
+    from nextmv import Status
+    ```
+
+    This enum represents the possible states of a run. It is deprecated and
+    `StatusV2` should be used for new implementations.
+
+    Attributes
+    ----------
+    failed : str
+        Run failed.
+    running : str
+        Run is running.
+    succeeded : str
+        Run succeeded.
+
+    Examples
+    --------
+    >>> from nextmv.cloud import Status
+    >>> current_status = Status.running
+    >>> if current_status == Status.succeeded:
+    ...     print("Run completed successfully.")
+    ... elif current_status == Status.failed:
+    ...     print("Run failed.")
+    ... else:
+    ...     print(f"Run is currently {current_status.value}.")
+    Run is currently running.
+
+    """
+
+    failed = "failed"
+    """Run failed."""
+    running = "running"
+    """Run is running."""
+    succeeded = "succeeded"
+    """Run succeeded."""
+
+
+class StatusV2(str, Enum):
+    """
+    Status of a run.
+
+    You can import the `StatusV2` class directly from `nextmv`:
+
+    ```python
+    from nextmv import StatusV2
+    ```
+
+    This enum represents the comprehensive set of possible states for a run
+    in Nextmv.
+
+    Attributes
+    ----------
+    canceled : str
+        Run was canceled.
+    failed : str
+        Run failed.
+    none : str
+        Run has no status.
+    queued : str
+        Run is queued.
+    running : str
+        Run is running.
+    succeeded : str
+        Run succeeded.
+
+    Examples
+    --------
+    >>> from nextmv.cloud import StatusV2
+    >>> run_status = StatusV2.queued
+    >>> print(f"The run status is: {run_status.value}")
+    The run status is: queued
+
+    >>> if run_status == StatusV2.succeeded:
+    ...     print("Processing complete.")
+    ... elif run_status in [StatusV2.queued, StatusV2.running]:
+    ...     print("Processing in progress.")
+    ... else:
+    ...     print("Processing has not started or has ended with issues.")
+    Processing in progress.
+
+    """
+
+    canceled = "canceled"
+    """Run was canceled."""
+    failed = "failed"
+    """Run failed."""
+    none = "none"
+    """Run has no status."""
+    queued = "queued"
+    """Run is queued."""
+    running = "running"
+    """Run is running."""
+    succeeded = "succeeded"
+    """Run succeeded."""

nextmv-1.0.0.dev2.dist-info/METADATA

@@ -0,0 +1,311 @@
+Metadata-Version: 2.4
+Name: nextmv
+Version: 1.0.0.dev2
+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/
+Project-URL: Repository, https://github.com/nextmv-io/nextmv-py
+Author-email: Nextmv <tech@nextmv.io>
+Maintainer-email: Nextmv <tech@nextmv.io>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2022-2023 nextmv.io inc.
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+Keywords: decision engineering,decision science,decisions,nextmv,operations research,optimization,shift scheduling,solver,vehicle routing problem
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.5.2
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: requests>=2.31.0
+Requires-Dist: typer>=0.20.1
+Requires-Dist: urllib3>=2.1.0
+Provides-Extra: all
+Requires-Dist: folium>=0.20.0; 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'
+Requires-Dist: ruff>=0.1.7; extra == 'dev'
+Requires-Dist: twine>=4.0.2; extra == 'dev'
+Requires-Dist: urllib3>=2.1.0; extra == 'dev'
+Provides-Extra: notebook
+Requires-Dist: mlflow>=2.19.0; extra == 'notebook'
+Description-Content-Type: text/markdown
+
+# 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 `nextmv`, visit the [docs][docs].
+
+## Installation
+
+Requires Python `>=3.10`. Install using the Python package manager of your
+choice:
+
+- `pip`
+
+    ```bash
+    pip install nextmv
+    ```
+
+- `pipx`
+
+    ```bash
+    pipx install nextmv
+    ```
+
+- `uv`
+
+    ```bash
+    uv tool install nextmv
+    ```
+
+Install all optional dependencies (recommended) by specifying `"nextmv[all]"`
+instead of just `"nextmv"`.
+
+## CLI
+
+The Nextmv CLI is installed automatically with the SDK. To verify installation,
+run:
+
+```bash
+nextmv --help
+```
+
+If you are contributing to the CLI, please make sure you read the [CLI
+Contributing Guide][cli-contributing].
+
+[docs]: https://nextmv-py.docs.nextmv.io/en/latest/nextmv/
+[cli-contributing]: nextmv/cli/CONTRIBUTING.md