runloop-api-client 0.26.0__tar.gz → 0.28.0__tar.gz

runloop_api_client-0.28.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.28.0"
+}

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## 0.28.0 (2025-03-21)
+
+Full Changelog: [v0.27.0...v0.28.0](https://github.com/runloopai/api-client-python/compare/v0.27.0...v0.28.0)
+
+### Features
+
+* **api:** api update ([#575](https://github.com/runloopai/api-client-python/issues/575)) ([c6f1ca5](https://github.com/runloopai/api-client-python/commit/c6f1ca5d4101b6c1b62326a1bf4d7bd090461595))
+
+## 0.27.0 (2025-03-21)
+
+Full Changelog: [v0.26.0...v0.27.0](https://github.com/runloopai/api-client-python/compare/v0.26.0...v0.27.0)
+
+### Features
+
+* **api:** api update ([#573](https://github.com/runloopai/api-client-python/issues/573)) ([091f833](https://github.com/runloopai/api-client-python/commit/091f833d80096bb0470d505c0a0145648e52819b))
+
+
+### Bug Fixes
+
+* **ci:** ensure pip is always available ([#571](https://github.com/runloopai/api-client-python/issues/571)) ([ddb9362](https://github.com/runloopai/api-client-python/commit/ddb93629704f116cafb2123dc8b302ddff883bb8))
+* **ci:** remove publishing patch ([#572](https://github.com/runloopai/api-client-python/issues/572)) ([c71815a](https://github.com/runloopai/api-client-python/commit/c71815aaaf47e404e1bf3d44c6b26b5ed0b05054))
+* **types:** handle more discriminated union shapes ([#570](https://github.com/runloopai/api-client-python/issues/570)) ([297cfbe](https://github.com/runloopai/api-client-python/commit/297cfbe93bfdcbbafd44a4501d5a81a7fb1651bd))
+
+
+### Chores
+
+* **internal:** bump rye to 0.44.0 ([#569](https://github.com/runloopai/api-client-python/issues/569)) ([dd5b79a](https://github.com/runloopai/api-client-python/commit/dd5b79a221fff5b38fdbd655d78254fe7140fd73))
+* **internal:** remove extra empty newlines ([#567](https://github.com/runloopai/api-client-python/issues/567)) ([49f34bd](https://github.com/runloopai/api-client-python/commit/49f34bd0b733f2a10592fff098d379501df3ac86))
+
+
+### Documentation
+
+* revise readme docs about nested params ([#564](https://github.com/runloopai/api-client-python/issues/564)) ([a2df5d3](https://github.com/runloopai/api-client-python/commit/a2df5d3c9b32ab941ee83d3f5cac8b874b7bbe28))
+
 ## 0.26.0 (2025-03-04)
 
 Full Changelog: [v0.25.0...v0.26.0](https://github.com/runloopai/api-client-python/compare/v0.25.0...v0.26.0)

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/PKG-INFO

@@ -1,12 +1,11 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.3
 Name: runloop_api_client
-Version: 0.26.0
+Version: 0.28.0
 Summary: The official Python library for the runloop API
 Project-URL: Homepage, https://github.com/runloopai/api-client-python
 Project-URL: Repository, https://github.com/runloopai/api-client-python
 Author-email: Runloop <support@runloop.ai>
-License-Expression: MIT
-License-File: LICENSE
+License: MIT
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: MacOS
@@ -168,6 +167,33 @@ for devbox in first_page.devboxes:
 # Remove `await` for non-async usage.
 ```
 
+## Nested params
+
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
+
+```python
+from runloop_api_client import Runloop
+
+client = Runloop()
+
+blueprint_view = client.blueprints.create(
+    name="name",
+    launch_parameters={
+        "after_idle": {
+            "idle_time_seconds": 0,
+            "on_idle": "shutdown",
+        },
+        "available_ports": [0],
+        "custom_cpu_cores": 0,
+        "custom_gb_memory": 0,
+        "keep_alive_time_seconds": 0,
+        "launch_commands": ["string"],
+        "resource_size_request": "SMALL",
+    },
+)
+print(blueprint_view.launch_parameters)
+```
+
 ## File uploads
 
 Request parameters that correspond to file uploads can be passed as `bytes`, a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/README.md

@@ -136,6 +136,33 @@ for devbox in first_page.devboxes:
 # Remove `await` for non-async usage.
 ```
 
+## Nested params
+
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
+
+```python
+from runloop_api_client import Runloop
+
+client = Runloop()
+
+blueprint_view = client.blueprints.create(
+    name="name",
+    launch_parameters={
+        "after_idle": {
+            "idle_time_seconds": 0,
+            "on_idle": "shutdown",
+        },
+        "available_ports": [0],
+        "custom_cpu_cores": 0,
+        "custom_gb_memory": 0,
+        "keep_alive_time_seconds": 0,
+        "launch_commands": ["string"],
+        "resource_size_request": "SMALL",
+    },
+)
+print(blueprint_view.launch_parameters)
+```
+
 ## File uploads
 
 Request parameters that correspond to file uploads can be passed as `bytes`, a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.

runloop_api_client-0.28.0/bin/publish-pypi

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -eux
+mkdir -p dist
+rye build --clean
+rye publish --yes --token=$PYPI_TOKEN

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "runloop_api_client"
-version = "0.26.0"
+version = "0.28.0"
 description = "The official Python library for the runloop API"
 dynamic = ["readme"]
 license = "MIT"
@@ -38,7 +38,6 @@ Homepage = "https://github.com/runloopai/api-client-python"
 Repository = "https://github.com/runloopai/api-client-python"
 
 
-
 [tool.rye]
 managed = true
 # version pins are in requirements-dev.lock
@@ -87,7 +86,7 @@ typecheck = { chain = [
 "typecheck:mypy" = "mypy ."
 
 [build-system]
-requires = ["hatchling", "hatch-fancy-pypi-readme"]
+requires = ["hatchling==1.26.3", "hatch-fancy-pypi-readme"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build]
@@ -152,7 +151,6 @@ reportImplicitOverride = true
 reportImportCycles = false
 reportPrivateUsage = false
 
-
 [tool.ruff]
 line-length = 120
 output-format = "grouped"

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/_models.py

@@ -65,7 +65,7 @@ from ._compat import (
 from ._constants import RAW_RESPONSE_HEADER
 
 if TYPE_CHECKING:
-    from pydantic_core.core_schema import ModelField, LiteralSchema, ModelFieldsSchema
+    from pydantic_core.core_schema import ModelField, ModelSchema, LiteralSchema, ModelFieldsSchema
 
 __all__ = ["BaseModel", "GenericModel"]
 
@@ -646,15 +646,18 @@ def _build_discriminated_union_meta(*, union: type, meta_annotations: tuple[Any,
 
 def _extract_field_schema_pv2(model: type[BaseModel], field_name: str) -> ModelField | None:
     schema = model.__pydantic_core_schema__
+    if schema["type"] == "definitions":
+        schema = schema["schema"]
+
     if schema["type"] != "model":
         return None
 
+    schema = cast("ModelSchema", schema)
     fields_schema = schema["schema"]
     if fields_schema["type"] != "model-fields":
         return None
 
     fields_schema = cast("ModelFieldsSchema", fields_schema)
-
     field = fields_schema["fields"].get(field_name)
     if not field:
         return None

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "runloop_api_client"
-__version__ = "0.26.0"  # x-release-please-version
+__version__ = "0.28.0"  # x-release-please-version

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/resources/scenarios/runs.py

@@ -141,8 +141,10 @@ class RunsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
         idempotency_key: str | None = None,
     ) -> ScenarioRunView:
-        """
-        Complete a currently running ScenarioRun.
+        """Complete a currently running ScenarioRun.
+
+        Calling complete will shutdown
+        underlying Devbox resource.
 
         Args:
           extra_headers: Send extra headers
@@ -467,8 +469,10 @@ class AsyncRunsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
         idempotency_key: str | None = None,
     ) -> ScenarioRunView:
-        """
-        Complete a currently running ScenarioRun.
+        """Complete a currently running ScenarioRun.
+
+        Calling complete will shutdown
+        underlying Devbox resource.
 
         Args:
           extra_headers: Send extra headers

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/benchmark_list_view.py

@@ -14,4 +14,6 @@ class BenchmarkListView(BaseModel):
 
     has_more: bool
 
+    remaining_count: int
+
     total_count: int

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/benchmark_run_list_view.py

@@ -11,6 +11,8 @@ __all__ = ["BenchmarkRunListView"]
 class BenchmarkRunListView(BaseModel):
     has_more: bool
 
+    remaining_count: int
+
     runs: List[BenchmarkRunView]
     """List of BenchmarkRuns matching filter."""
 

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/blueprint_list_view.py

@@ -14,4 +14,6 @@ class BlueprintListView(BaseModel):
 
     has_more: bool
 
+    remaining_count: int
+
     total_count: int

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/devbox_list_view.py

@@ -14,4 +14,6 @@ class DevboxListView(BaseModel):
 
     has_more: bool
 
+    remaining_count: int
+
     total_count: int

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/devbox_snapshot_list_view.py

@@ -11,6 +11,8 @@ __all__ = ["DevboxSnapshotListView"]
 class DevboxSnapshotListView(BaseModel):
     has_more: bool
 
+    remaining_count: int
+
     snapshots: List[DevboxSnapshotView]
     """List of snapshots matching filter."""
 

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/repository_connection_list_view.py

@@ -11,6 +11,8 @@ __all__ = ["RepositoryConnectionListView"]
 class RepositoryConnectionListView(BaseModel):
     has_more: bool
 
+    remaining_count: int
+
     repositories: List[RepositoryConnectionView]
     """List of repositories matching filter."""
 

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/scenario_list_view.py

@@ -11,6 +11,8 @@ __all__ = ["ScenarioListView"]
 class ScenarioListView(BaseModel):
     has_more: bool
 
+    remaining_count: int
+
     scenarios: List[ScenarioView]
     """List of Scenarios matching filter."""
 

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/scenario_run_list_view.py

@@ -11,6 +11,8 @@ __all__ = ["ScenarioRunListView"]
 class ScenarioRunListView(BaseModel):
     has_more: bool
 
+    remaining_count: int
+
     runs: List[ScenarioRunView]
     """List of ScenarioRuns matching filter."""
 

runloop_api_client-0.28.0/src/runloop_api_client/types/scoring_function.py

@@ -0,0 +1,125 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from .._utils import PropertyInfo
+from .._models import BaseModel
+
+__all__ = [
+    "ScoringFunction",
+    "Scorer",
+    "ScorerAstGrepScoringFunction",
+    "ScorerBashScriptScoringFunction",
+    "ScorerCommandScoringFunction",
+    "ScorerCustomScoringFunction",
+    "ScorerPythonScriptScoringFunction",
+    "ScorerTestBasedScoringFunction",
+    "ScorerTestBasedScoringFunctionTestFile",
+]
+
+
+class ScorerAstGrepScoringFunction(BaseModel):
+    pattern: str
+    """AST pattern to match."""
+
+    search_directory: str
+    """The path to search."""
+
+    type: Literal["ast_grep_scorer"]
+
+    lang: Optional[str] = None
+    """The language of the pattern."""
+
+
+class ScorerBashScriptScoringFunction(BaseModel):
+    type: Literal["bash_script_scorer"]
+
+    bash_script: Optional[str] = None
+    """
+    A single bash script that sets up the environment, scores, and prints the final
+    score to standard out. Score should be a float between 0.0 and 1.0, and look
+    like "score=[0.0..1.0].
+    """
+
+
+class ScorerCommandScoringFunction(BaseModel):
+    type: Literal["command_scorer"]
+
+    command: Optional[str] = None
+    """The command to execute."""
+
+
+class ScorerCustomScoringFunction(BaseModel):
+    type: Literal["custom_scorer"]
+
+    scorer_params: Optional[object] = None
+    """Additional JSON structured context to pass to the scoring function."""
+
+
+class ScorerPythonScriptScoringFunction(BaseModel):
+    python_script: str
+    """Python script to be run.
+
+    The script should output the score to standard out as a float between 0.0 and
+    1.0.
+    """
+
+    type: Literal["python_script_scorer"]
+
+    requirements_contents: Optional[str] = None
+    """Package dependencies to be installed.
+
+    The requirements should be a valid requirements.txt file.
+    """
+
+
+class ScorerTestBasedScoringFunctionTestFile(BaseModel):
+    file_contents: Optional[str] = None
+    """Content of the test file"""
+
+    file_path: Optional[str] = None
+    """
+    Path to write content of the test file, relative to your environment's working
+    directory
+    """
+
+
+class ScorerTestBasedScoringFunction(BaseModel):
+    type: Literal["test_based_scorer"]
+
+    test_command: Optional[str] = None
+    """The command to execute for running the tests"""
+
+    test_files: Optional[List[ScorerTestBasedScoringFunctionTestFile]] = None
+    """List of test files to create"""
+
+
+Scorer: TypeAlias = Annotated[
+    Union[
+        ScorerAstGrepScoringFunction,
+        ScorerBashScriptScoringFunction,
+        ScorerCommandScoringFunction,
+        ScorerCustomScoringFunction,
+        ScorerPythonScriptScoringFunction,
+        ScorerTestBasedScoringFunction,
+    ],
+    PropertyInfo(discriminator="type"),
+]
+
+
+class ScoringFunction(BaseModel):
+    name: str
+    """Name of scoring function. Names must only contain [a-zA-Z0-9_-]."""
+
+    scorer: Scorer
+    """The scoring function to use for evaluating this scenario.
+
+    The type field determines which built-in function to use.
+    """
+
+    weight: float
+    """Weight to apply to scoring function score.
+
+    Weights of all scoring functions should sum to 1.0.
+    """

runloop_api_client-0.28.0/src/runloop_api_client/types/scoring_function_param.py

@@ -0,0 +1,121 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+__all__ = [
+    "ScoringFunctionParam",
+    "Scorer",
+    "ScorerAstGrepScoringFunction",
+    "ScorerBashScriptScoringFunction",
+    "ScorerCommandScoringFunction",
+    "ScorerCustomScoringFunction",
+    "ScorerPythonScriptScoringFunction",
+    "ScorerTestBasedScoringFunction",
+    "ScorerTestBasedScoringFunctionTestFile",
+]
+
+
+class ScorerAstGrepScoringFunction(TypedDict, total=False):
+    pattern: Required[str]
+    """AST pattern to match."""
+
+    search_directory: Required[str]
+    """The path to search."""
+
+    type: Required[Literal["ast_grep_scorer"]]
+
+    lang: str
+    """The language of the pattern."""
+
+
+class ScorerBashScriptScoringFunction(TypedDict, total=False):
+    type: Required[Literal["bash_script_scorer"]]
+
+    bash_script: str
+    """
+    A single bash script that sets up the environment, scores, and prints the final
+    score to standard out. Score should be a float between 0.0 and 1.0, and look
+    like "score=[0.0..1.0].
+    """
+
+
+class ScorerCommandScoringFunction(TypedDict, total=False):
+    type: Required[Literal["command_scorer"]]
+
+    command: str
+    """The command to execute."""
+
+
+class ScorerCustomScoringFunction(TypedDict, total=False):
+    type: Required[Literal["custom_scorer"]]
+
+    scorer_params: Optional[object]
+    """Additional JSON structured context to pass to the scoring function."""
+
+
+class ScorerPythonScriptScoringFunction(TypedDict, total=False):
+    python_script: Required[str]
+    """Python script to be run.
+
+    The script should output the score to standard out as a float between 0.0 and
+    1.0.
+    """
+
+    type: Required[Literal["python_script_scorer"]]
+
+    requirements_contents: str
+    """Package dependencies to be installed.
+
+    The requirements should be a valid requirements.txt file.
+    """
+
+
+class ScorerTestBasedScoringFunctionTestFile(TypedDict, total=False):
+    file_contents: str
+    """Content of the test file"""
+
+    file_path: str
+    """
+    Path to write content of the test file, relative to your environment's working
+    directory
+    """
+
+
+class ScorerTestBasedScoringFunction(TypedDict, total=False):
+    type: Required[Literal["test_based_scorer"]]
+
+    test_command: str
+    """The command to execute for running the tests"""
+
+    test_files: Iterable[ScorerTestBasedScoringFunctionTestFile]
+    """List of test files to create"""
+
+
+Scorer: TypeAlias = Union[
+    ScorerAstGrepScoringFunction,
+    ScorerBashScriptScoringFunction,
+    ScorerCommandScoringFunction,
+    ScorerCustomScoringFunction,
+    ScorerPythonScriptScoringFunction,
+    ScorerTestBasedScoringFunction,
+]
+
+
+class ScoringFunctionParam(TypedDict, total=False):
+    name: Required[str]
+    """Name of scoring function. Names must only contain [a-zA-Z0-9_-]."""
+
+    scorer: Required[Scorer]
+    """The scoring function to use for evaluating this scenario.
+
+    The type field determines which built-in function to use.
+    """
+
+    weight: Required[float]
+    """Weight to apply to scoring function score.
+
+    Weights of all scoring functions should sum to 1.0.
+    """

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/shared/launch_parameters.py

@@ -23,6 +23,12 @@ class LaunchParameters(BaseModel):
     'createTunnel' API.
     """
 
+    custom_cpu_cores: Optional[int] = None
+    """custom resource size, number of cpu cores, must be multiple of 2."""
+
+    custom_gb_memory: Optional[int] = None
+    """custom memory size, number in Gi, must be a multiple of 2."""
+
     keep_alive_time_seconds: Optional[int] = None
     """Time in seconds after which Devbox will automatically shutdown.
 

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/src/runloop_api_client/types/shared_params/launch_parameters.py

@@ -24,6 +24,12 @@ class LaunchParameters(TypedDict, total=False):
     'createTunnel' API.
     """
 
+    custom_cpu_cores: Optional[int]
+    """custom resource size, number of cpu cores, must be multiple of 2."""
+
+    custom_gb_memory: Optional[int]
+    """custom memory size, number in Gi, must be a multiple of 2."""
+
     keep_alive_time_seconds: Optional[int]
     """Time in seconds after which Devbox will automatically shutdown.
 

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/tests/api_resources/scenarios/test_scorers.py

@@ -196,6 +196,8 @@ class TestScorers:
                         "on_idle": "shutdown",
                     },
                     "available_ports": [0],
+                    "custom_cpu_cores": 0,
+                    "custom_gb_memory": 0,
                     "keep_alive_time_seconds": 0,
                     "launch_commands": ["string"],
                     "resource_size_request": "SMALL",
@@ -417,6 +419,8 @@ class TestAsyncScorers:
                         "on_idle": "shutdown",
                     },
                     "available_ports": [0],
+                    "custom_cpu_cores": 0,
+                    "custom_gb_memory": 0,
                     "keep_alive_time_seconds": 0,
                     "launch_commands": ["string"],
                     "resource_size_request": "SMALL",

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/tests/api_resources/test_blueprints.py

@@ -49,6 +49,8 @@ class TestBlueprints:
                     "on_idle": "shutdown",
                 },
                 "available_ports": [0],
+                "custom_cpu_cores": 0,
+                "custom_gb_memory": 0,
                 "keep_alive_time_seconds": 0,
                 "launch_commands": ["string"],
                 "resource_size_request": "SMALL",
@@ -218,6 +220,8 @@ class TestBlueprints:
                     "on_idle": "shutdown",
                 },
                 "available_ports": [0],
+                "custom_cpu_cores": 0,
+                "custom_gb_memory": 0,
                 "keep_alive_time_seconds": 0,
                 "launch_commands": ["string"],
                 "resource_size_request": "SMALL",
@@ -281,6 +285,8 @@ class TestAsyncBlueprints:
                     "on_idle": "shutdown",
                 },
                 "available_ports": [0],
+                "custom_cpu_cores": 0,
+                "custom_gb_memory": 0,
                 "keep_alive_time_seconds": 0,
                 "launch_commands": ["string"],
                 "resource_size_request": "SMALL",
@@ -450,6 +456,8 @@ class TestAsyncBlueprints:
                     "on_idle": "shutdown",
                 },
                 "available_ports": [0],
+                "custom_cpu_cores": 0,
+                "custom_gb_memory": 0,
                 "keep_alive_time_seconds": 0,
                 "launch_commands": ["string"],
                 "resource_size_request": "SMALL",

{runloop_api_client-0.26.0 → runloop_api_client-0.28.0}/tests/api_resources/test_devboxes.py

@@ -65,6 +65,8 @@ class TestDevboxes:
                     "on_idle": "shutdown",
                 },
                 "available_ports": [0],
+                "custom_cpu_cores": 0,
+                "custom_gb_memory": 0,
                 "keep_alive_time_seconds": 0,
                 "launch_commands": ["string"],
                 "resource_size_request": "SMALL",
@@ -938,6 +940,8 @@ class TestAsyncDevboxes:
                     "on_idle": "shutdown",
                 },
                 "available_ports": [0],
+                "custom_cpu_cores": 0,
+                "custom_gb_memory": 0,
                 "keep_alive_time_seconds": 0,
                 "launch_commands": ["string"],
                 "resource_size_request": "SMALL",