vellum-ai 0.11.8__py3-none-any.whl → 0.11.9__py3-none-any.whl

vellum/client/core/client_wrapper.py

@@ -17,7 +17,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "0.11.8",
+            "X-Fern-SDK-Version": "0.11.9",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

{vellum_ai-0.11.8.dist-info → vellum_ai-0.11.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.11.8
+Version: 0.11.9
 Summary: 
 License: MIT
 Requires-Python: >=3.9,<4.0

{vellum_ai-0.11.8.dist-info → vellum_ai-0.11.9.dist-info}/RECORD

@@ -1,17 +1,17 @@
 vellum_cli/CONTRIBUTING.md,sha256=FtDC7BGxSeMnwCXAUssFsAIElXtmJE-O5Z7BpolcgvI,2935
 vellum_cli/README.md,sha256=2NudRoLzWxNKqnuVy1JuQ7DerIaxWGYkrH8kMd-asIE,90
-vellum_cli/__init__.py,sha256=pftUQ6FiyfebNEB8xcfwzLjpfFDCAiH15xHBU6xr_wY,6733
+vellum_cli/__init__.py,sha256=XG6aC1NSPfBjNFzqiy9Lbk4DnELCKO8lpIZ3jeJR0r0,6990
 vellum_cli/aliased_group.py,sha256=ugW498j0yv4ALJ8vS9MsO7ctDW7Jlir9j6nE_uHAP8c,3363
 vellum_cli/config.py,sha256=wJQnv3tCgu1BOugg0AOP94yQ-x1yAg8juX_QoFN9Y7w,5223
 vellum_cli/image_push.py,sha256=SJwhwWJsLjwGNezNVd_oCVpFMfPsAB3dfLWmriZZUtw,4419
 vellum_cli/logger.py,sha256=PuRFa0WCh4sAGFS5aqWB0QIYpS6nBWwPJrIXpWxugV4,1022
-vellum_cli/pull.py,sha256=6wIiorqSx2rmR6atZJHHBuLSviocxK_n0DQxEDGmCzo,4008
+vellum_cli/pull.py,sha256=EkQirsTe0KCpJ8oHTE3S9_M2XHSrb2wrXNq4hTkMZng,5770
 vellum_cli/push.py,sha256=kbvlzZ9KnkS5DxxKHQP5ZvHHk1-CbCDg9LqnIRAWyt4,5258
 vellum_cli/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vellum_cli/tests/conftest.py,sha256=eFGwBxib3Nki830lIFintB0b6r4x8T_KMnmzhlTY5x0,1337
 vellum_cli/tests/test_config.py,sha256=uvKGDc8BoVyT9_H0Z-g8469zVxomn6Oi3Zj-vK7O_wU,2631
 vellum_cli/tests/test_main.py,sha256=qDZG-aQauPwBwM6A2DIu1494n47v3pL28XakTbLGZ-k,272
-vellum_cli/tests/test_pull.py,sha256=N6ZphvHYGokclbpbTpgOmpu_m2GtocDEesbdeHFjO5Y,13194
+vellum_cli/tests/test_pull.py,sha256=pGqpBkahC360UITDE8BlcJ7LPd9DyRPn4NrCNdkQmAQ,15907
 vellum_cli/tests/test_push.py,sha256=V2iGcskh2X3OHj2uV5Vx_BhmtyfmUkyx0lrp8DDOExc,5824
 vellum_ee/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vellum_ee/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -79,7 +79,7 @@ vellum/client/README.md,sha256=JkCJjmMZl4jrPj46pkmL9dpK4gSzQQmP5I7z4aME4LY,4749
 vellum/client/__init__.py,sha256=o4m7iRZWEV8rP3GkdaztHAjNmjxjWERlarviFoHzuKI,110927
 vellum/client/core/__init__.py,sha256=SQ85PF84B9MuKnBwHNHWemSGuy-g_515gFYNFhvEE0I,1438
 vellum/client/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
-vellum/client/core/client_wrapper.py,sha256=KtxhfH7jJZXfEPTJ_JeglwXX43TbY0JGd81hjEJN-Gw,1890
+vellum/client/core/client_wrapper.py,sha256=7ETrjiHmBNoSjt9dOpoOQoV1KfdagFOllIIAwyOIi8U,1890
 vellum/client/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 vellum/client/core/file.py,sha256=X9IbmkZmB2bB_DpmZAO3crWdXagOakAyn6UCOCImCPg,2322
 vellum/client/core/http_client.py,sha256=R0pQpCppnEtxccGvXl4uJ76s7ro_65Fo_erlNNLp_AI,19228
@@ -1378,8 +1378,8 @@ vellum/workflows/vellum_client.py,sha256=ODrq_TSl-drX2aezXegf7pizpWDVJuTXH-j6528
 vellum/workflows/workflows/__init__.py,sha256=KY45TqvavCCvXIkyCFMEc0dc6jTMOUci93U2DUrlZYc,66
 vellum/workflows/workflows/base.py,sha256=mnI-kZ78yt7u6NFSTUo-tYjDnarP-RJ7uZjwjCn6PCQ,16795
 vellum/workflows/workflows/event_filters.py,sha256=-uQcMB7IpPd-idMku8f2QNVhPXPFWo6FZLlGjRf8rCo,1996
-vellum_ai-0.11.8.dist-info/LICENSE,sha256=hOypcdt481qGNISA784bnAGWAE6tyIf9gc2E78mYC3E,1574
-vellum_ai-0.11.8.dist-info/METADATA,sha256=7H-xm-0FDR9QYaVdqlM8w4rVbWfsK9-0osBbv0npgWk,5128
-vellum_ai-0.11.8.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-vellum_ai-0.11.8.dist-info/entry_points.txt,sha256=HCH4yc_V3J_nDv3qJzZ_nYS8llCHZViCDP1ejgCc5Ak,42
-vellum_ai-0.11.8.dist-info/RECORD,,
+vellum_ai-0.11.9.dist-info/LICENSE,sha256=hOypcdt481qGNISA784bnAGWAE6tyIf9gc2E78mYC3E,1574
+vellum_ai-0.11.9.dist-info/METADATA,sha256=mbIOikcPuEIU344kVitGc9qdEQCbVQn5_-GrKT7XgdI,5128
+vellum_ai-0.11.9.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+vellum_ai-0.11.9.dist-info/entry_points.txt,sha256=HCH4yc_V3J_nDv3qJzZ_nYS8llCHZViCDP1ejgCc5Ak,42
+vellum_ai-0.11.9.dist-info/RECORD,,

vellum_cli/__init__.py

@@ -148,6 +148,11 @@ def pull(
 Should only be used for debugging purposes.""",
 )
 @click.option("--workflow-sandbox-id", type=str, help="Pull the Workflow from a specific Sandbox ID")
+@click.option(
+    "--workflow-deployment",
+    type=str,
+    help="""Pull the Workflow from a specific Deployment. Can use the name or the ID of the Deployment.""",
+)
 @click.option(
     "--exclude-code",
     is_flag=True,
@@ -158,6 +163,7 @@ def workflows_pull(
     module: Optional[str],
     include_json: Optional[bool],
     workflow_sandbox_id: Optional[str],
+    workflow_deployment: Optional[str],
     exclude_code: Optional[bool],
 ) -> None:
     """
@@ -169,6 +175,7 @@ def workflows_pull(
         module=module,
         include_json=include_json,
         workflow_sandbox_id=workflow_sandbox_id,
+        workflow_deployment=workflow_deployment,
         exclude_code=exclude_code,
     )
 

vellum_cli/pull.py

@@ -1,39 +1,84 @@
 import io
 import os
 from pathlib import Path
+from uuid import UUID
 import zipfile
-from typing import Optional
+from typing import Optional, Union
 
 from dotenv import load_dotenv
+from pydash import snake_case
 
+from vellum.client.core.pydantic_utilities import UniversalBaseModel
 from vellum.workflows.vellum_client import create_vellum_client
 from vellum_cli.config import VellumCliConfig, WorkflowConfig, load_vellum_cli_config
 from vellum_cli.logger import load_cli_logger
 
 
-def resolve_workflow_config(
+def _is_valid_uuid(val: Union[str, UUID, None]) -> bool:
+    try:
+        UUID(str(val))
+        return True
+    except (ValueError, TypeError):
+        return False
+
+
+class WorkflowConfigResolutionResult(UniversalBaseModel):
+    workflow_config: Optional[WorkflowConfig] = None
+    pk: Optional[str] = None
+
+
+def _resolve_workflow_config(
     config: VellumCliConfig,
     module: Optional[str] = None,
     workflow_sandbox_id: Optional[str] = None,
-) -> Optional[WorkflowConfig]:
+    workflow_deployment: Optional[str] = None,
+) -> WorkflowConfigResolutionResult:
+    if workflow_sandbox_id and workflow_deployment:
+        raise ValueError("Cannot specify both workflow_sandbox_id and workflow_deployment")
+
     if module:
-        return next((w for w in config.workflows if w.module == module), None)
+        workflow_config = next((w for w in config.workflows if w.module == module), None)
+        return WorkflowConfigResolutionResult(
+            workflow_config=workflow_config,
+            pk=workflow_config.workflow_sandbox_id if workflow_config else None,
+        )
     elif workflow_sandbox_id:
         workflow_config = WorkflowConfig(
             workflow_sandbox_id=workflow_sandbox_id,
             module=f"workflow_{workflow_sandbox_id.split('-')[0]}",
         )
         config.workflows.append(workflow_config)
-        return workflow_config
+        return WorkflowConfigResolutionResult(
+            workflow_config=workflow_config,
+            pk=workflow_config.workflow_sandbox_id,
+        )
+    elif workflow_deployment:
+        module = (
+            f"workflow_{workflow_deployment.split('-')[0]}"
+            if _is_valid_uuid(workflow_deployment)
+            else snake_case(workflow_deployment)
+        )
+        workflow_config = WorkflowConfig(
+            module=module,
+        )
+        config.workflows.append(workflow_config)
+        return WorkflowConfigResolutionResult(
+            workflow_config=workflow_config,
+            pk=workflow_deployment,
+        )
     elif config.workflows:
-        return config.workflows[0]
+        return WorkflowConfigResolutionResult(
+            workflow_config=config.workflows[0],
+            pk=config.workflows[0].workflow_sandbox_id,
+        )
 
-    return None
+    return WorkflowConfigResolutionResult()
 
 
 def pull_command(
     module: Optional[str] = None,
     workflow_sandbox_id: Optional[str] = None,
+    workflow_deployment: Optional[str] = None,
     include_json: Optional[bool] = None,
     exclude_code: Optional[bool] = None,
 ) -> None:
@@ -41,17 +86,20 @@ def pull_command(
     logger = load_cli_logger()
     config = load_vellum_cli_config()
 
-    workflow_config = resolve_workflow_config(
-        config,
-        module,
-        workflow_sandbox_id,
+    workflow_config_result = _resolve_workflow_config(
+        config=config,
+        module=module,
+        workflow_sandbox_id=workflow_sandbox_id,
+        workflow_deployment=workflow_deployment,
     )
     save_lock_file = not module
 
+    workflow_config = workflow_config_result.workflow_config
     if not workflow_config:
         raise ValueError("No workflow config found in project to pull from.")
 
-    if not workflow_config.workflow_sandbox_id:
+    pk = workflow_config_result.pk
+    if not pk:
         raise ValueError("No workflow sandbox ID found in project to pull from.")
 
     logger.info(f"Pulling workflow into {workflow_config.module}")
@@ -63,7 +111,7 @@ def pull_command(
         query_parameters["exclude_code"] = exclude_code
 
     response = client.workflows.pull(
-        workflow_config.workflow_sandbox_id,
+        pk,
         request_options={"additional_query_parameters": query_parameters},
     )
 

vellum_cli/tests/test_pull.py

@@ -164,6 +164,86 @@ def test_pull__sandbox_id_with_other_workflow_configured(vellum_client, mock_mod
         assert f.read() == "print('hello')"
 
 
+def test_pull__workflow_deployment_with_no_config(vellum_client):
+    # GIVEN a workflow deployment
+    workflow_deployment = "my-deployment"
+
+    # AND the workflow pull API call returns a zip file
+    vellum_client.workflows.pull.return_value = iter([_zip_file_map({"workflow.py": "print('hello')"})])
+
+    # AND we are currently in a new directory
+    current_dir = os.getcwd()
+    temp_dir = tempfile.mkdtemp()
+    os.chdir(temp_dir)
+
+    # WHEN the user runs the pull command with the workflow deployment
+    runner = CliRunner()
+    result = runner.invoke(cli_main, ["workflows", "pull", "--workflow-deployment", workflow_deployment])
+    os.chdir(current_dir)
+
+    # THEN the command returns successfully
+    assert result.exit_code == 0
+
+    # AND the pull api is called with the workflow deployment
+    vellum_client.workflows.pull.assert_called_once()
+    workflow_py = os.path.join(temp_dir, "my_deployment", "workflow.py")
+    assert os.path.exists(workflow_py)
+    with open(workflow_py) as f:
+        assert f.read() == "print('hello')"
+
+    # AND the vellum.lock.json file is created
+    vellum_lock_json = os.path.join(temp_dir, "vellum.lock.json")
+    assert os.path.exists(vellum_lock_json)
+    with open(vellum_lock_json) as f:
+        lock_data = json.loads(f.read())
+        assert lock_data == {
+            "version": "1.0",
+            "workflows": [
+                {
+                    "module": "my_deployment",
+                    "workflow_sandbox_id": None,
+                    "ignore": None,
+                    "deployments": [],
+                }
+            ],
+        }
+
+
+def test_pull__both_workflow_sandbox_id_and_deployment(vellum_client):
+    # GIVEN a workflow sandbox id
+    workflow_sandbox_id = "87654321-0000-0000-0000-000000000000"
+
+    # AND a workflow deployment
+    workflow_deployment = "my-deployment"
+
+    # AND the workflow pull API call returns a zip file
+    vellum_client.workflows.pull.return_value = iter([_zip_file_map({"workflow.py": "print('hello')"})])
+
+    # AND we are currently in a new directory
+    current_dir = os.getcwd()
+    temp_dir = tempfile.mkdtemp()
+    os.chdir(temp_dir)
+
+    # WHEN the user runs the pull command with the workflow deployment
+    runner = CliRunner()
+    result = runner.invoke(
+        cli_main,
+        [
+            "workflows",
+            "pull",
+            "--workflow-sandbox-id",
+            workflow_sandbox_id,
+            "--workflow-deployment",
+            workflow_deployment,
+        ],
+    )
+    os.chdir(current_dir)
+
+    # THEN the command returns successfully
+    assert result.exit_code == 1
+    assert "Cannot specify both workflow_sandbox_id and workflow_deployment" == str(result.exception)
+
+
 def test_pull__remove_missing_files(vellum_client, mock_module):
     # GIVEN a module on the user's filesystem
     temp_dir = mock_module.temp_dir