runwayml 3.0.3__tar.gz → 3.0.5__tar.gz

runwayml-3.0.5/.release-please-manifest.json

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

{runwayml-3.0.3 → runwayml-3.0.5}/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 3.0.5 (2025-05-10)
+
+Full Changelog: [v3.0.4...v3.0.5](https://github.com/runwayml/sdk-python/compare/v3.0.4...v3.0.5)
+
+### Bug Fixes
+
+* **package:** support direct resource imports ([f317064](https://github.com/runwayml/sdk-python/commit/f3170641fd7e8a58bfc8135314407e887a3a0068))
+
+
+### Chores
+
+* **internal:** avoid errors for isinstance checks on proxies ([a549b98](https://github.com/runwayml/sdk-python/commit/a549b98239afa6984f306db53cd2ac4895a7f4ac))
+
+## 3.0.4 (2025-04-30)
+
+Full Changelog: [v3.0.3...v3.0.4](https://github.com/runwayml/sdk-python/compare/v3.0.3...v3.0.4)
+
+### Bug Fixes
+
+* **api:** Fix for parameters with missing descriptions ([1ab27c6](https://github.com/runwayml/sdk-python/commit/1ab27c6285263701b69ed1ea05751a78a333e25f))
+* **api:** Make `ratio` a required parameter for i2v ([e1b73a5](https://github.com/runwayml/sdk-python/commit/e1b73a55073ae5d0d224b751726515d946a93607))
+
 ## 3.0.3 (2025-04-24)
 
 Full Changelog: [v3.0.2...v3.0.3](https://github.com/runwayml/sdk-python/compare/v3.0.2...v3.0.3)

{runwayml-3.0.3 → runwayml-3.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: runwayml
-Version: 3.0.3
+Version: 3.0.5
 Summary: The official Python library for the runwayml API
 Project-URL: Homepage, https://github.com/runwayml/sdk-python
 Project-URL: Repository, https://github.com/runwayml/sdk-python
@@ -65,6 +65,7 @@ client = RunwayML(
 image_to_video = client.image_to_video.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 print(image_to_video.id)
@@ -93,6 +94,7 @@ async def main() -> None:
     image_to_video = await client.image_to_video.create(
         model="gen4_turbo",
         prompt_image="https://example.com/assets/bunny.jpg",
+        ratio="1280:720",
         prompt_text="The bunny is eating a carrot",
     )
     print(image_to_video.id)
@@ -131,6 +133,7 @@ try:
     client.image_to_video.create(
         model="gen4_turbo",
         prompt_image="https://example.com/assets/bunny.jpg",
+        ratio="1280:720",
         prompt_text="The bunny is eating a carrot",
     )
 except runwayml.APIConnectionError as e:
@@ -178,6 +181,7 @@ client = RunwayML(
 client.with_options(max_retries=5).image_to_video.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 ```
@@ -205,6 +209,7 @@ client = RunwayML(
 client.with_options(timeout=5.0).image_to_video.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 ```
@@ -250,6 +255,7 @@ client = RunwayML()
 response = client.image_to_video.with_raw_response.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 print(response.headers.get('X-My-Header'))
@@ -272,6 +278,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 with client.image_to_video.with_streaming_response.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 ) as response:
     print(response.headers.get("X-My-Header"))

{runwayml-3.0.3 → runwayml-3.0.5}/README.md

@@ -34,6 +34,7 @@ client = RunwayML(
 image_to_video = client.image_to_video.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 print(image_to_video.id)
@@ -62,6 +63,7 @@ async def main() -> None:
     image_to_video = await client.image_to_video.create(
         model="gen4_turbo",
         prompt_image="https://example.com/assets/bunny.jpg",
+        ratio="1280:720",
         prompt_text="The bunny is eating a carrot",
     )
     print(image_to_video.id)
@@ -100,6 +102,7 @@ try:
     client.image_to_video.create(
         model="gen4_turbo",
         prompt_image="https://example.com/assets/bunny.jpg",
+        ratio="1280:720",
         prompt_text="The bunny is eating a carrot",
     )
 except runwayml.APIConnectionError as e:
@@ -147,6 +150,7 @@ client = RunwayML(
 client.with_options(max_retries=5).image_to_video.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 ```
@@ -174,6 +178,7 @@ client = RunwayML(
 client.with_options(timeout=5.0).image_to_video.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 ```
@@ -219,6 +224,7 @@ client = RunwayML()
 response = client.image_to_video.with_raw_response.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 print(response.headers.get('X-My-Header'))
@@ -241,6 +247,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 with client.image_to_video.with_streaming_response.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 ) as response:
     print(response.headers.get("X-My-Header"))

{runwayml-3.0.3 → runwayml-3.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "runwayml"
-version = "3.0.3"
+version = "3.0.5"
 description = "The official Python library for the runwayml API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{runwayml-3.0.3 → runwayml-3.0.5}/src/runwayml/__init__.py

@@ -1,5 +1,7 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+import typing as _t
+
 from . import types
 from ._types import NOT_GIVEN, Omit, NoneType, NotGiven, Transport, ProxiesTypes
 from ._utils import file_from_path
@@ -78,6 +80,9 @@ __all__ = [
     "DefaultAsyncHttpxClient",
 ]
 
+if not _t.TYPE_CHECKING:
+    from ._utils._resources_proxy import resources as resources
+
 _setup_logging()
 
 # Update the __module__ attribute for exported symbols so that

{runwayml-3.0.3 → runwayml-3.0.5}/src/runwayml/_utils/_proxy.py

@@ -46,7 +46,10 @@ class LazyProxy(Generic[T], ABC):
     @property  # type: ignore
     @override
     def __class__(self) -> type:  # pyright: ignore
-        proxied = self.__get_proxied__()
+        try:
+            proxied = self.__get_proxied__()
+        except Exception:
+            return type(self)
         if issubclass(type(proxied), LazyProxy):
             return type(proxied)
         return proxied.__class__

runwayml-3.0.5/src/runwayml/_utils/_resources_proxy.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import Any
+from typing_extensions import override
+
+from ._proxy import LazyProxy
+
+
+class ResourcesProxy(LazyProxy[Any]):
+    """A proxy for the `runwayml.resources` module.
+
+    This is used so that we can lazily import `runwayml.resources` only when
+    needed *and* so that users can just import `runwayml` and reference `runwayml.resources`
+    """
+
+    @override
+    def __load__(self) -> Any:
+        import importlib
+
+        mod = importlib.import_module("runwayml.resources")
+        return mod
+
+
+resources = ResourcesProxy().__as_proxied__()

{runwayml-3.0.3 → runwayml-3.0.5}/src/runwayml/_version.py

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

{runwayml-3.0.3 → runwayml-3.0.5}/src/runwayml/resources/image_to_video.py

@@ -49,10 +49,9 @@ class ImageToVideoResource(SyncAPIResource):
         *,
         model: Literal["gen4_turbo", "gen3a_turbo"],
         prompt_image: Union[str, Iterable[image_to_video_create_params.PromptImagePromptImage]],
+        ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"],
         duration: Literal[5, 10] | NotGiven = NOT_GIVEN,
         prompt_text: str | NotGiven = NOT_GIVEN,
-        ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"]
-        | NotGiven = NOT_GIVEN,
         seed: int | NotGiven = NOT_GIVEN,
         # 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.
@@ -71,11 +70,27 @@ class ImageToVideoResource(SyncAPIResource):
               frame of the generated video. See [our docs](/assets/inputs#images) on image
               inputs for more information.
 
-          duration: The number of seconds of duration for the output video.
+          ratio: The resolution of the output video.
+
+              `gen4_turbo` supports the following values:
+
+              - `1280:720`
+              - `720:1280`
+              - `1104:832`
+              - `832:1104`
+              - `960:960`
+              - `1584:672`
+
+              `gen3a_turbo` supports the following values:
 
-          prompt_text
+              - `1280:768`
+              - `768:1280`
 
-          ratio
+          duration: The number of seconds of duration for the output video.
+
+          prompt_text: A non-empty string up to 1000 UTF-16 code points in length (that is,
+              `promptText.length === 1000` in JavaScript). This should describe in detail what
+              should appear in the output.
 
           seed: If unspecified, a random number is chosen. Varying the seed integer is a way to
               get different results for the same other request parameters. Using the same seed
@@ -95,9 +110,9 @@ class ImageToVideoResource(SyncAPIResource):
                 {
                     "model": model,
                     "prompt_image": prompt_image,
+                    "ratio": ratio,
                     "duration": duration,
                     "prompt_text": prompt_text,
-                    "ratio": ratio,
                     "seed": seed,
                 },
                 image_to_video_create_params.ImageToVideoCreateParams,
@@ -134,10 +149,9 @@ class AsyncImageToVideoResource(AsyncAPIResource):
         *,
         model: Literal["gen4_turbo", "gen3a_turbo"],
         prompt_image: Union[str, Iterable[image_to_video_create_params.PromptImagePromptImage]],
+        ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"],
         duration: Literal[5, 10] | NotGiven = NOT_GIVEN,
         prompt_text: str | NotGiven = NOT_GIVEN,
-        ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"]
-        | NotGiven = NOT_GIVEN,
         seed: int | NotGiven = NOT_GIVEN,
         # 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.
@@ -156,11 +170,27 @@ class AsyncImageToVideoResource(AsyncAPIResource):
               frame of the generated video. See [our docs](/assets/inputs#images) on image
               inputs for more information.
 
-          duration: The number of seconds of duration for the output video.
+          ratio: The resolution of the output video.
+
+              `gen4_turbo` supports the following values:
+
+              - `1280:720`
+              - `720:1280`
+              - `1104:832`
+              - `832:1104`
+              - `960:960`
+              - `1584:672`
+
+              `gen3a_turbo` supports the following values:
 
-          prompt_text
+              - `1280:768`
+              - `768:1280`
 
-          ratio
+          duration: The number of seconds of duration for the output video.
+
+          prompt_text: A non-empty string up to 1000 UTF-16 code points in length (that is,
+              `promptText.length === 1000` in JavaScript). This should describe in detail what
+              should appear in the output.
 
           seed: If unspecified, a random number is chosen. Varying the seed integer is a way to
               get different results for the same other request parameters. Using the same seed
@@ -180,9 +210,9 @@ class AsyncImageToVideoResource(AsyncAPIResource):
                 {
                     "model": model,
                     "prompt_image": prompt_image,
+                    "ratio": ratio,
                     "duration": duration,
                     "prompt_text": prompt_text,
-                    "ratio": ratio,
                     "seed": seed,
                 },
                 image_to_video_create_params.ImageToVideoCreateParams,

{runwayml-3.0.3 → runwayml-3.0.5}/src/runwayml/types/image_to_video_create_params.py

@@ -21,12 +21,35 @@ class ImageToVideoCreateParams(TypedDict, total=False):
     inputs for more information.
     """
 
+    ratio: Required[
+        Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"]
+    ]
+    """The resolution of the output video.
+
+    `gen4_turbo` supports the following values:
+
+    - `1280:720`
+    - `720:1280`
+    - `1104:832`
+    - `832:1104`
+    - `960:960`
+    - `1584:672`
+
+    `gen3a_turbo` supports the following values:
+
+    - `1280:768`
+    - `768:1280`
+    """
+
     duration: Literal[5, 10]
     """The number of seconds of duration for the output video."""
 
     prompt_text: Annotated[str, PropertyInfo(alias="promptText")]
-
-    ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"]
+    """
+    A non-empty string up to 1000 UTF-16 code points in length (that is,
+    `promptText.length === 1000` in JavaScript). This should describe in detail what
+    should appear in the output.
+    """
 
     seed: int
     """If unspecified, a random number is chosen.

{runwayml-3.0.3 → runwayml-3.0.5}/tests/api_resources/test_image_to_video.py

@@ -22,6 +22,7 @@ class TestImageToVideo:
         image_to_video = client.image_to_video.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         )
         assert_matches_type(ImageToVideoCreateResponse, image_to_video, path=["response"])
 
@@ -30,9 +31,9 @@ class TestImageToVideo:
         image_to_video = client.image_to_video.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
             duration=5,
             prompt_text="promptText",
-            ratio="1280:720",
             seed=0,
         )
         assert_matches_type(ImageToVideoCreateResponse, image_to_video, path=["response"])
@@ -42,6 +43,7 @@ class TestImageToVideo:
         response = client.image_to_video.with_raw_response.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         )
 
         assert response.is_closed is True
@@ -54,6 +56,7 @@ class TestImageToVideo:
         with client.image_to_video.with_streaming_response.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -72,6 +75,7 @@ class TestAsyncImageToVideo:
         image_to_video = await async_client.image_to_video.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         )
         assert_matches_type(ImageToVideoCreateResponse, image_to_video, path=["response"])
 
@@ -80,9 +84,9 @@ class TestAsyncImageToVideo:
         image_to_video = await async_client.image_to_video.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
             duration=5,
             prompt_text="promptText",
-            ratio="1280:720",
             seed=0,
         )
         assert_matches_type(ImageToVideoCreateResponse, image_to_video, path=["response"])
@@ -92,6 +96,7 @@ class TestAsyncImageToVideo:
         response = await async_client.image_to_video.with_raw_response.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         )
 
         assert response.is_closed is True
@@ -104,6 +109,7 @@ class TestAsyncImageToVideo:
         async with async_client.image_to_video.with_streaming_response.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"

{runwayml-3.0.3 → runwayml-3.0.5}/tests/test_client.py

@@ -725,6 +725,7 @@ class TestRunwayML:
                         dict(
                             model="gen4_turbo",
                             prompt_image="https://example.com/assets/bunny.jpg",
+                            ratio="1280:720",
                             prompt_text="The bunny is eating a carrot",
                         ),
                         ImageToVideoCreateParams,
@@ -750,6 +751,7 @@ class TestRunwayML:
                         dict(
                             model="gen4_turbo",
                             prompt_image="https://example.com/assets/bunny.jpg",
+                            ratio="1280:720",
                             prompt_text="The bunny is eating a carrot",
                         ),
                         ImageToVideoCreateParams,
@@ -788,7 +790,7 @@ class TestRunwayML:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com"
+            model="gen4_turbo", prompt_image="https://example.com", ratio="1280:720"
         )
 
         assert response.retries_taken == failures_before_success
@@ -814,7 +816,10 @@ class TestRunwayML:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com", extra_headers={"x-stainless-retry-count": Omit()}
+            model="gen4_turbo",
+            prompt_image="https://example.com",
+            ratio="1280:720",
+            extra_headers={"x-stainless-retry-count": Omit()},
         )
 
         assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0
@@ -839,7 +844,10 @@ class TestRunwayML:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com", extra_headers={"x-stainless-retry-count": "42"}
+            model="gen4_turbo",
+            prompt_image="https://example.com",
+            ratio="1280:720",
+            extra_headers={"x-stainless-retry-count": "42"},
         )
 
         assert response.http_request.headers.get("x-stainless-retry-count") == "42"
@@ -1527,6 +1535,7 @@ class TestAsyncRunwayML:
                         dict(
                             model="gen4_turbo",
                             prompt_image="https://example.com/assets/bunny.jpg",
+                            ratio="1280:720",
                             prompt_text="The bunny is eating a carrot",
                         ),
                         ImageToVideoCreateParams,
@@ -1552,6 +1561,7 @@ class TestAsyncRunwayML:
                         dict(
                             model="gen4_turbo",
                             prompt_image="https://example.com/assets/bunny.jpg",
+                            ratio="1280:720",
                             prompt_text="The bunny is eating a carrot",
                         ),
                         ImageToVideoCreateParams,
@@ -1591,7 +1601,7 @@ class TestAsyncRunwayML:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = await client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com"
+            model="gen4_turbo", prompt_image="https://example.com", ratio="1280:720"
         )
 
         assert response.retries_taken == failures_before_success
@@ -1618,7 +1628,10 @@ class TestAsyncRunwayML:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = await client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com", extra_headers={"x-stainless-retry-count": Omit()}
+            model="gen4_turbo",
+            prompt_image="https://example.com",
+            ratio="1280:720",
+            extra_headers={"x-stainless-retry-count": Omit()},
         )
 
         assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0
@@ -1644,7 +1657,10 @@ class TestAsyncRunwayML:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = await client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com", extra_headers={"x-stainless-retry-count": "42"}
+            model="gen4_turbo",
+            prompt_image="https://example.com",
+            ratio="1280:720",
+            extra_headers={"x-stainless-retry-count": "42"},
         )
 
         assert response.http_request.headers.get("x-stainless-retry-count") == "42"

{runwayml-3.0.3 → runwayml-3.0.5}/tests/test_utils/test_proxy.py

@@ -21,3 +21,14 @@ def test_recursive_proxy() -> None:
     assert dir(proxy) == []
     assert type(proxy).__name__ == "RecursiveLazyProxy"
     assert type(operator.attrgetter("name.foo.bar.baz")(proxy)).__name__ == "RecursiveLazyProxy"
+
+
+def test_isinstance_does_not_error() -> None:
+    class AlwaysErrorProxy(LazyProxy[Any]):
+        @override
+        def __load__(self) -> Any:
+            raise RuntimeError("Mocking missing dependency")
+
+    proxy = AlwaysErrorProxy()
+    assert not isinstance(proxy, dict)
+    assert isinstance(proxy, LazyProxy)

runwayml-3.0.3/.release-please-manifest.json

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