nextmv 0.1.0.dev16__tar.gz → 0.2.0.dev0__tar.gz

{nextmv-0.1.0.dev16 → nextmv-0.2.0.dev0}/.github/workflows/publish.yml

@@ -7,27 +7,22 @@ on:
         description: "The version to release"
         required: true
       IS_PRE_RELEASE:
-        description: "Whether this is a pre-release"
+        description: "It IS a pre-release"
         required: true
         default: false
         type: boolean
 
-permissions:
-  contents: write
-
 jobs:
-  publish:
+  bump: # This job is used to bump the version and create a release
     runs-on: ubuntu-latest
     env:
       VERSION: ${{ inputs.VERSION }}
       GH_TOKEN: ${{ github.token }}
+      SSH_AUTH_SOCK: /tmp/ssh_agent.sock
+    permissions:
+      contents: write
     steps:
-      - name: git clone develop
-        uses: actions/checkout@v4
-        with:
-          ref: develop
-
-      - name: Set up Python
+      - name: set up Python
         uses: actions/setup-python@v4
         with:
           python-version: "3.12"
@@ -35,33 +30,9 @@ jobs:
       - name: install dependencies
         run: |
           pip install --upgrade pip
-          pip install build twine hatch
-
-      - name: upgrade version with hatch
-        run: hatch version ${{ env.VERSION }}
-
-      - name: build binary wheel and source tarball
-        env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: |
-          python -m build
-
-      - name: publish to TestPyPI
-        env:
-          TWINE_USERNAME: ${{ secrets.TESTPYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.TESTPYPI_PASSWORD }}
-        run: twine upload --repository testpypi dist/*
-
-      - name: publish to PyPI
-        env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: twine upload dist/*
+          pip install build hatch
 
       - name: configure git with the bot credentials
-        env:
-          SSH_AUTH_SOCK: /tmp/ssh_agent.sock
         run: |
           mkdir -p ~/.ssh
           ssh-keyscan github.com >> ~/.ssh/known_hosts
@@ -73,10 +44,15 @@ jobs:
 
           git config --global user.name "nextmv-bot"
           git config --global user.email "tech+gh-nextmv-bot@nextmv.io"
-          git config --global url."git@github.com:".insteadOf "https://github.com/"
           git config --global gpg.format ssh
           git config --global user.signingkey ~/.ssh/signing.key
 
+          git clone git@github.com:nextmv-io/nextmv-py.git
+
+      - name: upgrade version with hatch
+        run: hatch version ${{ env.VERSION }}
+        working-directory: ./nextmv-py
+
       - name: commit new version
         run: |
           git add nextmv/__about__.py
@@ -84,6 +60,7 @@ jobs:
           git push
           git tag $VERSION
           git push origin $VERSION
+        working-directory: ./nextmv-py
 
       - name: create release
         run: |
@@ -92,7 +69,60 @@ jobs:
             PRERELEASE_FLAG="--prerelease"
           fi
 
-          gh release create -R nextmv-io/nextmv-py $VERSION \
+          gh release create $VERSION \
           --verify-tag \
           --generate-notes \
           --title $VERSION $PRERELEASE_FLAG
+        working-directory: ./nextmv-py
+
+      - name: ensure passing build
+        run: python -m build
+        working-directory: ./nextmv-py
+
+  publish: # This job is used to publish the release to PyPI/TestPyPI
+    runs-on: ubuntu-latest
+    needs: bump
+    strategy:
+      matrix:
+        include:
+          - target-env: pypi
+            target-url: https://pypi.org/p/nextmv
+          - target-env: testpypi
+            target-url: https://test.pypi.org/p/nextmv
+    environment:
+      name: ${{ matrix.target-env }}
+      url: ${{ matrix.target-url }}
+    permissions:
+      contents: read
+      id-token: write # This is required for trusted publishing to PyPI
+    steps:
+      - name: git clone develop
+        uses: actions/checkout@v4
+        with:
+          ref: develop
+
+      - name: set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install build hatch
+
+      - name: build binary wheel and source tarball
+        run: python -m build
+
+      - name: Publish package distributions to PyPI
+        if: ${{ matrix.target-env == 'pypi' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: ./dist
+
+      - name: Publish package distributions to TestPyPI
+        if: ${{ matrix.target-env == 'testpypi' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          packages-dir: ./dist

{nextmv-0.1.0.dev16 → nextmv-0.2.0.dev0}/.gitignore

@@ -158,3 +158,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# VSCode
+.vscode/

{nextmv-0.1.0.dev16 → nextmv-0.2.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nextmv
-Version: 0.1.0.dev16
+Version: 0.2.0.dev0
 Summary: The Python SDK for Nextmv
 Project-URL: Homepage, https://www.nextmv.io
 Project-URL: Documentation, https://www.nextmv.io/docs
@@ -215,6 +215,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
 Requires-Dist: pydantic>=2.5.2
+Requires-Dist: pyyaml>=6.0.1
 Requires-Dist: requests>=2.31.0
 Description-Content-Type: text/markdown
 
@@ -229,7 +230,7 @@ Visit the [docs][docs] for more information.
 
 ## Installation
 
-Install using `pip`:
+Requires Python `>=3.10`. Install using `pip`:
 
 ```bash
 pip install nextmv
@@ -240,17 +241,17 @@ pip install nextmv
 Make sure that you have your API key set as an environment variable:
 
 ```bash
-export NEXTMV_API_KEY=<your-API-key>
+export NEXTMV_API_KEY="<YOUR-API-KEY>"
 ```
 
-Additionally, you must have a valid app in the Nextmv Cloud.
+Additionally, you must have a valid app in Nextmv Cloud.
 
 - Make a run and get the results.
 
 ```python
 import os
 
-from nextmv.cloud import Application, Client
+from nextmv.cloud import Application, Client, PollingOptions
 
 input = {
     "defaults": {"vehicles": {"speed": 20}},
@@ -276,11 +277,12 @@ input = {
 }
 
 client = Client(api_key=os.getenv("NEXTMV_API_KEY"))
-app = Application(client=client, id="your-app-id")
+app = Application(client=client, id="<YOUR-APP-ID>")
 result = app.new_run_with_result(
     input=input,
     instance_id="latest",
     run_options={"solve.duration": "1s"},
+    polling_options=PollingOptions(),  # Customize the polling options.
 )
 print(result.to_dict())
 

{nextmv-0.1.0.dev16 → nextmv-0.2.0.dev0}/README.md

@@ -9,7 +9,7 @@ Visit the [docs][docs] for more information.
 
 ## Installation
 
-Install using `pip`:
+Requires Python `>=3.10`. Install using `pip`:
 
 ```bash
 pip install nextmv
@@ -20,17 +20,17 @@ pip install nextmv
 Make sure that you have your API key set as an environment variable:
 
 ```bash
-export NEXTMV_API_KEY=<your-API-key>
+export NEXTMV_API_KEY="<YOUR-API-KEY>"
 ```
 
-Additionally, you must have a valid app in the Nextmv Cloud.
+Additionally, you must have a valid app in Nextmv Cloud.
 
 - Make a run and get the results.
 
 ```python
 import os
 
-from nextmv.cloud import Application, Client
+from nextmv.cloud import Application, Client, PollingOptions
 
 input = {
     "defaults": {"vehicles": {"speed": 20}},
@@ -56,11 +56,12 @@ input = {
 }
 
 client = Client(api_key=os.getenv("NEXTMV_API_KEY"))
-app = Application(client=client, id="your-app-id")
+app = Application(client=client, id="<YOUR-APP-ID>")
 result = app.new_run_with_result(
     input=input,
     instance_id="latest",
     run_options={"solve.duration": "1s"},
+    polling_options=PollingOptions(),  # Customize the polling options.
 )
 print(result.to_dict())
 

nextmv-0.2.0.dev0/nextmv/__about__.py

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

{nextmv-0.1.0.dev16 → nextmv-0.2.0.dev0}/nextmv/cloud/application.py

@@ -443,7 +443,7 @@ class Application:
 
     def new_run(
         self,
-        input: dict[str, Any] = None,
+        input: dict[str, Any] | BaseModel = None,
         instance_id: str | None = None,
         name: str | None = None,
         description: str | None = None,
@@ -470,6 +470,9 @@ class Application:
             requests.HTTPError: If the response status code is not 2xx.
         """
 
+        if isinstance(input, BaseModel):
+            input = input.to_dict()
+
         input_size = 0
         if input is not None:
             input_size = get_size(input)
@@ -508,7 +511,7 @@ class Application:
 
     def new_run_with_result(
         self,
-        input: dict[str, Any] = None,
+        input: dict[str, Any] | BaseModel = None,
         instance_id: str | None = None,
         name: str | None = None,
         description: str | None = None,

{nextmv-0.1.0.dev16 → nextmv-0.2.0.dev0}/nextmv/cloud/client.py

@@ -7,6 +7,7 @@ from typing import Any
 from urllib.parse import urljoin
 
 import requests
+import yaml
 from requests.adapters import HTTPAdapter, Retry
 
 _MAX_LAMBDA_PAYLOAD_SIZE: int = 500 * 1024 * 1024
@@ -16,20 +17,21 @@ _MAX_LAMBDA_PAYLOAD_SIZE: int = 500 * 1024 * 1024
 @dataclass
 class Client:
     """
-    Client that interacts directly with the Nextmv Cloud API. The API key
-    must be provided either in the constructor or via the NEXTMV_API_KEY
-    environment variable.
+    Client that interacts directly with the Nextmv Cloud API. The API key will
+    be searched, in order of precedence, in: the api_key arg in the
+    constructor, the NEXTMV_API_KEY environment variable, the
+    ~/.nextmv/config.yaml file used by the Nextmv CLI.
     """
 
+    api_key: str | None = None
+    """API key to use for authenticating with the Nextmv Cloud API. If not
+    provided, the client will look for the NEXTMV_API_KEY environment
+    variable."""
     allowed_methods: list[str] = field(
         default_factory=lambda: ["GET", "POST", "PUT", "DELETE"],
     )
     """Allowed HTTP methods to use for retries in requests to the Nextmv Cloud
     API."""
-    api_key: str | None = None
-    """API key to use for authenticating with the Nextmv Cloud API. If not
-    provided, the client will look for the NEXTMV_API_KEY environment
-    variable."""
     backoff_factor: float = 1
     """Exponential backoff factor to use for requests to the Nextmv Cloud
     API."""
@@ -38,6 +40,8 @@ class Client:
     backoff_max: float = 60
     """Maximum backoff time to use for requests to the Nextmv Cloud API, in
     seconds."""
+    configuration_file: str = "~/.nextmv/config.yaml"
+    """Path to the configuration file used by the Nextmv CLI."""
     headers: dict[str, str] | None = None
     """Headers to use for requests to the Nextmv Cloud API."""
     max_retries: int = 10
@@ -55,14 +59,41 @@ class Client:
     def __post_init__(self):
         """Logic to run after the class is initialized."""
 
-        if self.api_key is None:
-            api_key = os.getenv("NEXTMV_API_KEY")
-            if api_key is None:
-                raise ValueError(
-                    "no API key provided. Either set it in the constructor or "
-                    "set the NEXTMV_API_KEY environment variable."
-                )
-            self.api_key = api_key
+        if self.api_key is not None and self.api_key != "":
+            return
+
+        if self.api_key == "":
+            raise ValueError("api_key cannot be empty")
+
+        api_key_env = os.getenv("NEXTMV_API_KEY")
+        if api_key_env is not None:
+            self.api_key = api_key_env
+            return
+
+        config_path = os.path.expanduser(self.configuration_file)
+        if not os.path.exists(config_path):
+            raise ValueError(
+                "no API key set in constructor or NEXTMV_API_KEY env var, and ~/.nextmv/config.yaml does not exist"
+            )
+
+        with open(config_path) as f:
+            config = yaml.safe_load(f)
+
+        profile = os.getenv("NEXTMV_PROFILE")
+        parent = config
+        if profile is not None:
+            parent = config.get(profile)
+            if parent is None:
+                raise ValueError(f"profile {profile} set via NEXTMV_PROFILE but not found in ~/.nextmv/config.yaml")
+
+        api_key = parent.get("apikey")
+        if api_key is None:
+            raise ValueError("no apiKey found in ~/.nextmv/config.yaml")
+        self.api_key = api_key
+
+        endpoint = parent.get("endpoint")
+        if endpoint is not None:
+            self.url = f"https://{endpoint}"
 
         self.headers = {
             "Authorization": f"Bearer {self.api_key}",

{nextmv-0.1.0.dev16 → nextmv-0.2.0.dev0}/pyproject.toml

@@ -14,6 +14,7 @@ classifiers = [
 dependencies = [
     "pydantic>=2.5.2",
     "requests>=2.31.0",
+    "pyyaml>=6.0.1",
 ]
 description = "The Python SDK for Nextmv"
 dynamic = [

{nextmv-0.1.0.dev16 → nextmv-0.2.0.dev0}/requirements.txt

@@ -1,5 +1,6 @@
 build>=1.0.3
 pydantic>=2.5.2
+pyyaml>=6.0.1
 requests>=2.31.0
 ruff>=0.1.7
 twine>=4.0.2

nextmv-0.2.0.dev0/tests/cloud/test_client.py

@@ -0,0 +1,25 @@
+import os
+import unittest
+
+from nextmv.cloud import Client
+
+
+class TestClient(unittest.TestCase):
+    def test_api_key(self):
+        client1 = Client(api_key="foo")
+        self.assertEqual(client1.api_key, "foo")
+
+        os.environ["NEXTMV_API_KEY"] = "bar"
+        client2 = Client()
+        self.assertEqual(client2.api_key, "bar")
+        os.environ.pop("NEXTMV_API_KEY")
+
+        with self.assertRaises(ValueError):
+            Client(api_key="")
+
+        with self.assertRaises(ValueError):
+            Client(configuration_file="")
+
+        os.environ["NEXTMV_PROFILE"] = "i-like-turtles"
+        with self.assertRaises(ValueError):
+            Client()

nextmv-0.1.0.dev16/nextmv/__about__.py

@@ -1 +0,0 @@
-__version__ = "v0.1.0.dev16"