runloop-api-client 0.43.0__tar.gz → 0.45.0__tar.gz

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

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

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 0.45.0 (2025-06-24)
+
+Full Changelog: [v0.44.0...v0.45.0](https://github.com/runloopai/api-client-python/compare/v0.44.0...v0.45.0)
+
+### Features
+
+* **api:** api update ([382b901](https://github.com/runloopai/api-client-python/commit/382b9018d26ce11e12d7143a84b80147be63ac2e))
+* **api:** api update ([3f896cf](https://github.com/runloopai/api-client-python/commit/3f896cf907ef15fc2f0d01f681844eef0bca9479))
+* **api:** api update ([9bb3abf](https://github.com/runloopai/api-client-python/commit/9bb3abf4b274d9e75940cc859eafd0f4f37027b8))
+
+
+### Chores
+
+* **tests:** skip some failing tests on the latest python versions ([27007c0](https://github.com/runloopai/api-client-python/commit/27007c0a1500e80cc9ac93cb634021a7cfb569e6))
+
+## 0.44.0 (2025-06-21)
+
+Full Changelog: [v0.43.0...v0.44.0](https://github.com/runloopai/api-client-python/compare/v0.43.0...v0.44.0)
+
+### Features
+
+* **api:** api update ([8bd0a39](https://github.com/runloopai/api-client-python/commit/8bd0a3937ff3d5b3e03a34ab2fc291377bbc4203))
+* **api:** api update ([8ebd055](https://github.com/runloopai/api-client-python/commit/8ebd055bb3760c7a01193df890ca7e56d7ff9c01))
+* **client:** add support for aiohttp ([4237321](https://github.com/runloopai/api-client-python/commit/4237321688934fcc89a17588800ce33fb47d9633))
+
+
+### Bug Fixes
+
+* **tests:** fix: tests which call HTTP endpoints directly with the example parameters ([038fe71](https://github.com/runloopai/api-client-python/commit/038fe71f5d0bee93bdcad12af69a8f5b09b6664f))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([f64b8a2](https://github.com/runloopai/api-client-python/commit/f64b8a2a52a28a86f25d8b8ad1998e9ce4dda542))
+* **internal:** update conftest.py ([d840c86](https://github.com/runloopai/api-client-python/commit/d840c863eb3b080202874080e44b8ab0baa379c4))
+* **readme:** update badges ([4b5af3f](https://github.com/runloopai/api-client-python/commit/4b5af3faf2f3cfbcee8474b864335eb0a4c0a78b))
+* **tests:** add tests for httpx client instantiation & proxies ([938b9aa](https://github.com/runloopai/api-client-python/commit/938b9aa33ef7ae52809ca6e9111fc3265d70263d))
+
+
+### Documentation
+
+* **client:** fix httpx.Timeout documentation reference ([b8df915](https://github.com/runloopai/api-client-python/commit/b8df91557df34f77ce5a6f85769305628d9f2a1d))
+
 ## 0.43.0 (2025-06-14)
 
 Full Changelog: [v0.42.0...v0.43.0](https://github.com/runloopai/api-client-python/compare/v0.42.0...v0.43.0)

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: runloop_api_client
-Version: 0.43.0
+Version: 0.45.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
@@ -27,11 +27,14 @@ Requires-Dist: httpx<1,>=0.23.0
 Requires-Dist: pydantic<3,>=1.9.0
 Requires-Dist: sniffio
 Requires-Dist: typing-extensions<5,>=4.10
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.6; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
 # Runloop Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/runloop_api_client.svg)](https://pypi.org/project/runloop_api_client/)
+[![PyPI version](https://github.com/runloopai/api-client-python/tree/main/<https://img.shields.io/pypi/v/runloop_api_client.svg?label=pypi%20(stable)>)](https://pypi.org/project/runloop_api_client/)
 
 The Runloop Python library provides convenient access to the Runloop REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -95,6 +98,38 @@ asyncio.run(main())
 
 Functionality between the synchronous and asynchronous clients is otherwise identical.
 
+### With aiohttp
+
+By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
+
+You can enable this by installing `aiohttp`:
+
+```sh
+# install from PyPI
+pip install runloop_api_client[aiohttp]
+```
+
+Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
+
+```python
+import os
+import asyncio
+from runloop_api_client import DefaultAioHttpClient
+from runloop_api_client import AsyncRunloop
+
+
+async def main() -> None:
+    async with AsyncRunloop(
+        bearer_token=os.environ.get("RUNLOOP_API_KEY"),  # This is the default and can be omitted
+        http_client=DefaultAioHttpClient(),
+    ) as client:
+        devbox_view = await client.devboxes.create()
+        print(devbox_view.id)
+
+
+asyncio.run(main())
+```
+
 ## Using types
 
 Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
@@ -266,7 +301,7 @@ client.with_options(max_retries=5).devboxes.create()
 ### Timeouts
 
 By default requests time out after 1 minute. You can configure this with a `timeout` option,
-which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
 from runloop_api_client import Runloop

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/README.md

@@ -1,6 +1,6 @@
 # Runloop Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/runloop_api_client.svg)](https://pypi.org/project/runloop_api_client/)
+[![PyPI version](<https://img.shields.io/pypi/v/runloop_api_client.svg?label=pypi%20(stable)>)](https://pypi.org/project/runloop_api_client/)
 
 The Runloop Python library provides convenient access to the Runloop REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -64,6 +64,38 @@ asyncio.run(main())
 
 Functionality between the synchronous and asynchronous clients is otherwise identical.
 
+### With aiohttp
+
+By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
+
+You can enable this by installing `aiohttp`:
+
+```sh
+# install from PyPI
+pip install runloop_api_client[aiohttp]
+```
+
+Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
+
+```python
+import os
+import asyncio
+from runloop_api_client import DefaultAioHttpClient
+from runloop_api_client import AsyncRunloop
+
+
+async def main() -> None:
+    async with AsyncRunloop(
+        bearer_token=os.environ.get("RUNLOOP_API_KEY"),  # This is the default and can be omitted
+        http_client=DefaultAioHttpClient(),
+    ) as client:
+        devbox_view = await client.devboxes.create()
+        print(devbox_view.id)
+
+
+asyncio.run(main())
+```
+
 ## Using types
 
 Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
@@ -235,7 +267,7 @@ client.with_options(max_retries=5).devboxes.create()
 ### Timeouts
 
 By default requests time out after 1 minute. You can configure this with a `timeout` option,
-which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
 from runloop_api_client import Runloop

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/api.md

@@ -264,13 +264,16 @@ Types:
 ```python
 from runloop_api_client.types import (
     InputContext,
+    InputContextUpdate,
     ScenarioCreateParameters,
     ScenarioEnvironment,
     ScenarioRunListView,
     ScenarioRunView,
+    ScenarioUpdateParameters,
     ScenarioView,
     ScoringContract,
     ScoringContractResultView,
+    ScoringContractUpdate,
     ScoringFunction,
     ScoringFunctionResultView,
     StartScenarioRunParameters,
@@ -294,6 +297,7 @@ Methods:
 - <code title="get /v1/scenarios/runs">client.scenarios.runs.<a href="./src/runloop_api_client/resources/scenarios/runs.py">list</a>(\*\*<a href="src/runloop_api_client/types/scenarios/run_list_params.py">params</a>) -> <a href="./src/runloop_api_client/types/scenario_run_view.py">SyncBenchmarkRunsCursorIDPage[ScenarioRunView]</a></code>
 - <code title="post /v1/scenarios/runs/{id}/cancel">client.scenarios.runs.<a href="./src/runloop_api_client/resources/scenarios/runs.py">cancel</a>(id) -> <a href="./src/runloop_api_client/types/scenario_run_view.py">ScenarioRunView</a></code>
 - <code title="post /v1/scenarios/runs/{id}/complete">client.scenarios.runs.<a href="./src/runloop_api_client/resources/scenarios/runs.py">complete</a>(id) -> <a href="./src/runloop_api_client/types/scenario_run_view.py">ScenarioRunView</a></code>
+- <code title="post /v1/scenarios/runs/{id}/download_logs">client.scenarios.runs.<a href="./src/runloop_api_client/resources/scenarios/runs.py">download_logs</a>(id) -> BinaryAPIResponse</code>
 - <code title="post /v1/scenarios/runs/{id}/score">client.scenarios.runs.<a href="./src/runloop_api_client/resources/scenarios/runs.py">score</a>(id) -> <a href="./src/runloop_api_client/types/scenario_run_view.py">ScenarioRunView</a></code>
 
 ## Scorers

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "runloop_api_client"
-version = "0.43.0"
+version = "0.45.0"
 description = "The official Python library for the runloop API"
 dynamic = ["readme"]
 license = "MIT"
@@ -37,6 +37,8 @@ classifiers = [
 Homepage = "https://github.com/runloopai/api-client-python"
 Repository = "https://github.com/runloopai/api-client-python"
 
+[project.optional-dependencies]
+aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.6"]
 
 [tool.rye]
 managed = true

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/requirements-dev.lock

@@ -10,6 +10,13 @@
 #   universal: false
 
 -e file:.
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.8
+    # via httpx-aiohttp
+    # via runloop-api-client
+aiosignal==1.3.2
+    # via aiohttp
 annotated-types==0.6.0
     # via pydantic
 anyio==4.4.0
@@ -17,6 +24,10 @@ anyio==4.4.0
     # via runloop-api-client
 argcomplete==3.1.2
     # via nox
+async-timeout==5.0.1
+    # via aiohttp
+attrs==25.3.0
+    # via aiohttp
 certifi==2023.7.22
     # via httpcore
     # via httpx
@@ -34,16 +45,23 @@ execnet==2.1.1
     # via pytest-xdist
 filelock==3.12.4
     # via virtualenv
+frozenlist==1.6.2
+    # via aiohttp
+    # via aiosignal
 h11==0.14.0
     # via httpcore
 httpcore==1.0.2
     # via httpx
 httpx==0.28.1
+    # via httpx-aiohttp
     # via respx
     # via runloop-api-client
+httpx-aiohttp==0.1.6
+    # via runloop-api-client
 idna==3.4
     # via anyio
     # via httpx
+    # via yarl
 importlib-metadata==7.0.0
 iniconfig==2.0.0
     # via pytest
@@ -51,6 +69,9 @@ markdown-it-py==3.0.0
     # via rich
 mdurl==0.1.2
     # via markdown-it-py
+multidict==6.4.4
+    # via aiohttp
+    # via yarl
 mypy==1.14.1
 mypy-extensions==1.0.0
     # via mypy
@@ -65,6 +86,9 @@ platformdirs==3.11.0
     # via virtualenv
 pluggy==1.5.0
     # via pytest
+propcache==0.3.1
+    # via aiohttp
+    # via yarl
 pydantic==2.10.3
     # via runloop-api-client
 pydantic-core==2.27.1
@@ -97,6 +121,7 @@ tomli==2.0.2
     # via pytest
 typing-extensions==4.12.2
     # via anyio
+    # via multidict
     # via mypy
     # via pydantic
     # via pydantic-core
@@ -104,5 +129,7 @@ typing-extensions==4.12.2
     # via runloop-api-client
 virtualenv==20.24.5
     # via nox
+yarl==1.20.0
+    # via aiohttp
 zipp==3.17.0
     # via importlib-metadata

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/requirements.lock

@@ -10,11 +10,22 @@
 #   universal: false
 
 -e file:.
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.8
+    # via httpx-aiohttp
+    # via runloop-api-client
+aiosignal==1.3.2
+    # via aiohttp
 annotated-types==0.6.0
     # via pydantic
 anyio==4.4.0
     # via httpx
     # via runloop-api-client
+async-timeout==5.0.1
+    # via aiohttp
+attrs==25.3.0
+    # via aiohttp
 certifi==2023.7.22
     # via httpcore
     # via httpx
@@ -22,15 +33,28 @@ distro==1.8.0
     # via runloop-api-client
 exceptiongroup==1.2.2
     # via anyio
+frozenlist==1.6.2
+    # via aiohttp
+    # via aiosignal
 h11==0.14.0
     # via httpcore
 httpcore==1.0.2
     # via httpx
 httpx==0.28.1
+    # via httpx-aiohttp
+    # via runloop-api-client
+httpx-aiohttp==0.1.6
     # via runloop-api-client
 idna==3.4
     # via anyio
     # via httpx
+    # via yarl
+multidict==6.4.4
+    # via aiohttp
+    # via yarl
+propcache==0.3.1
+    # via aiohttp
+    # via yarl
 pydantic==2.10.3
     # via runloop-api-client
 pydantic-core==2.27.1
@@ -40,6 +64,9 @@ sniffio==1.3.0
     # via runloop-api-client
 typing-extensions==4.12.2
     # via anyio
+    # via multidict
     # via pydantic
     # via pydantic-core
     # via runloop-api-client
+yarl==1.20.0
+    # via aiohttp

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/src/runloop_api_client/__init__.py

@@ -26,7 +26,7 @@ from ._exceptions import (
     UnprocessableEntityError,
     APIResponseValidationError,
 )
-from ._base_client import DefaultHttpxClient, DefaultAsyncHttpxClient
+from ._base_client import DefaultHttpxClient, DefaultAioHttpClient, DefaultAsyncHttpxClient
 from ._utils._logs import setup_logging as _setup_logging
 
 __all__ = [
@@ -68,6 +68,7 @@ __all__ = [
     "DEFAULT_CONNECTION_LIMITS",
     "DefaultHttpxClient",
     "DefaultAsyncHttpxClient",
+    "DefaultAioHttpClient",
 ]
 
 if not _t.TYPE_CHECKING:

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/src/runloop_api_client/_base_client.py

@@ -1289,6 +1289,24 @@ class _DefaultAsyncHttpxClient(httpx.AsyncClient):
         super().__init__(**kwargs)
 
 
+try:
+    import httpx_aiohttp
+except ImportError:
+
+    class _DefaultAioHttpClient(httpx.AsyncClient):
+        def __init__(self, **_kwargs: Any) -> None:
+            raise RuntimeError("To use the aiohttp client you must have installed the package with the `aiohttp` extra")
+else:
+
+    class _DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: Any) -> None:
+            kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
+            kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
+            kwargs.setdefault("follow_redirects", True)
+
+            super().__init__(**kwargs)
+
+
 if TYPE_CHECKING:
     DefaultAsyncHttpxClient = httpx.AsyncClient
     """An alias to `httpx.AsyncClient` that provides the same defaults that this SDK
@@ -1297,8 +1315,12 @@ if TYPE_CHECKING:
     This is useful because overriding the `http_client` with your own instance of
     `httpx.AsyncClient` will result in httpx's defaults being used, not ours.
     """
+
+    DefaultAioHttpClient = httpx.AsyncClient
+    """An alias to `httpx.AsyncClient` that changes the default HTTP transport to `aiohttp`."""
 else:
     DefaultAsyncHttpxClient = _DefaultAsyncHttpxClient
+    DefaultAioHttpClient = _DefaultAioHttpClient
 
 
 class AsyncHttpxClientWrapper(DefaultAsyncHttpxClient):

{runloop_api_client-0.43.0 → runloop_api_client-0.45.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.43.0"  # x-release-please-version
+__version__ = "0.45.0"  # x-release-please-version

{runloop_api_client-0.43.0 → runloop_api_client-0.45.0}/src/runloop_api_client/resources/scenarios/runs.py

@@ -9,10 +9,18 @@ from ..._utils import maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
 from ..._response import (
+    BinaryAPIResponse,
+    AsyncBinaryAPIResponse,
+    StreamedBinaryAPIResponse,
+    AsyncStreamedBinaryAPIResponse,
     to_raw_response_wrapper,
     to_streamed_response_wrapper,
     async_to_raw_response_wrapper,
+    to_custom_raw_response_wrapper,
     async_to_streamed_response_wrapper,
+    to_custom_streamed_response_wrapper,
+    async_to_custom_raw_response_wrapper,
+    async_to_custom_streamed_response_wrapper,
 )
 from ...pagination import SyncBenchmarkRunsCursorIDPage, AsyncBenchmarkRunsCursorIDPage
 from ..._exceptions import RunloopError
@@ -213,6 +221,48 @@ class RunsResource(SyncAPIResource):
             cast_to=ScenarioRunView,
         )
 
+    def download_logs(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        idempotency_key: str | None = None,
+    ) -> BinaryAPIResponse:
+        """
+        Download a zip file containing all logs for a Scenario run from the associated
+        devbox.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "application/zip", **(extra_headers or {})}
+        return self._post(
+            f"/v1/scenarios/runs/{id}/download_logs",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=BinaryAPIResponse,
+        )
+
     def score(
         self,
         id: str,
@@ -583,6 +633,48 @@ class AsyncRunsResource(AsyncAPIResource):
             cast_to=ScenarioRunView,
         )
 
+    async def download_logs(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        idempotency_key: str | None = None,
+    ) -> AsyncBinaryAPIResponse:
+        """
+        Download a zip file containing all logs for a Scenario run from the associated
+        devbox.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "application/zip", **(extra_headers or {})}
+        return await self._post(
+            f"/v1/scenarios/runs/{id}/download_logs",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=AsyncBinaryAPIResponse,
+        )
+
     async def score(
         self,
         id: str,
@@ -782,6 +874,10 @@ class RunsResourceWithRawResponse:
         self.complete = to_raw_response_wrapper(
             runs.complete,
         )
+        self.download_logs = to_custom_raw_response_wrapper(
+            runs.download_logs,
+            BinaryAPIResponse,
+        )
         self.score = to_raw_response_wrapper(
             runs.score,
         )
@@ -803,6 +899,10 @@ class AsyncRunsResourceWithRawResponse:
         self.complete = async_to_raw_response_wrapper(
             runs.complete,
         )
+        self.download_logs = async_to_custom_raw_response_wrapper(
+            runs.download_logs,
+            AsyncBinaryAPIResponse,
+        )
         self.score = async_to_raw_response_wrapper(
             runs.score,
         )
@@ -824,6 +924,10 @@ class RunsResourceWithStreamingResponse:
         self.complete = to_streamed_response_wrapper(
             runs.complete,
         )
+        self.download_logs = to_custom_streamed_response_wrapper(
+            runs.download_logs,
+            StreamedBinaryAPIResponse,
+        )
         self.score = to_streamed_response_wrapper(
             runs.score,
         )
@@ -845,6 +949,10 @@ class AsyncRunsResourceWithStreamingResponse:
         self.complete = async_to_streamed_response_wrapper(
             runs.complete,
         )
+        self.download_logs = async_to_custom_streamed_response_wrapper(
+            runs.download_logs,
+            AsyncStreamedBinaryAPIResponse,
+        )
         self.score = async_to_streamed_response_wrapper(
             runs.score,
         )