runcloud-sdk 0.8.2__tar.gz → 0.9.0__tar.gz

{runcloud_sdk-0.8.2/runcloud_sdk.egg-info → runcloud_sdk-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runcloud-sdk
-Version: 0.8.2
+Version: 0.9.0
 Summary: Python SDK for run.cloud, including sandbox-provider compatibility adapters
 Author: Newly
 License-Expression: Apache-2.0
@@ -62,6 +62,21 @@ finally:
 automation, set `RUN_CLOUD_API_KEY` and optionally `RUN_CLOUD_API_URL`, or pass
 `api_key` and `api_url` directly.
 
+A sandbox's name is a label you own: set it at create, change it later, and
+filter on it. Naming plus `resume` is how the same sandbox goes back to the same
+piece of work instead of booting a new one:
+
+```python
+matches = cloud.list(name=f"project-{project_id}")
+box = matches[0].resume() if matches else cloud.create(name=f"project-{project_id}")
+
+box.rename(f"project-{project_id}-v2")
+box.rename("")  # clears the label
+```
+
+Names are not unique and mean nothing to the platform, so check `state` on a
+match before using it. Renaming works in any state but `destroyed`.
+
 ## Compatibility adapters
 
 The same distribution includes migration adapters:

{runcloud_sdk-0.8.2 → runcloud_sdk-0.9.0}/README.md

@@ -44,6 +44,21 @@ finally:
 automation, set `RUN_CLOUD_API_KEY` and optionally `RUN_CLOUD_API_URL`, or pass
 `api_key` and `api_url` directly.
 
+A sandbox's name is a label you own: set it at create, change it later, and
+filter on it. Naming plus `resume` is how the same sandbox goes back to the same
+piece of work instead of booting a new one:
+
+```python
+matches = cloud.list(name=f"project-{project_id}")
+box = matches[0].resume() if matches else cloud.create(name=f"project-{project_id}")
+
+box.rename(f"project-{project_id}-v2")
+box.rename("")  # clears the label
+```
+
+Names are not unique and mean nothing to the platform, so check `state` on a
+match before using it. Renaming works in any state but `destroyed`.
+
 ## Compatibility adapters
 
 The same distribution includes migration adapters:

{runcloud_sdk-0.8.2 → runcloud_sdk-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "runcloud-sdk"
-version = "0.8.2"
+version = "0.9.0"
 description = "Python SDK for run.cloud, including sandbox-provider compatibility adapters"
 readme = "README.md"
 requires-python = ">=3.9"

{runcloud_sdk-0.8.2 → runcloud_sdk-0.9.0}/runcloud/client.py

@@ -20,7 +20,7 @@ from websockets.sync.client import connect as websocket_connect
 Transport = Callable[[str, str, Any], Any]
 StreamTransport = Callable[[str, dict[str, Any]], Any]
 DEFAULT_API_URL = "https://api.run.cloud"
-USER_AGENT = "runcloud-python/0.8.2"
+USER_AGENT = "runcloud-python/0.8.3"
 FILE_CHUNK_BYTES = 512 * 1024
 
 
@@ -253,7 +253,9 @@ class Client:
         explicit_api_key = _nonempty_string(api_key)
         environment_api_key = _nonempty_string(
             os.environ.get("RUN_CLOUD_API_KEY")
-        ) or _nonempty_string(os.environ.get("RUN_CLOUD_API_TOKEN"))
+        ) or _nonempty_string(
+            os.environ.get("RUN_CLOUD_API_TOKEN")
+        ) or _nonempty_string(os.environ.get("RUN_CLOUD_CI_ENVIRONMENT_TOKEN"))
         saved_credentials = (
             None
             if explicit_api_key or environment_api_key
@@ -370,8 +372,17 @@ class Client:
         sid = urllib.parse.quote(sandbox_id, safe="")
         return Sandbox(self, self.request("GET", f"/run-cloud/sandboxes/{sid}"))
 
-    def list(self, state: Optional[str] = None) -> list["Sandbox"]:
-        query = f"?state={urllib.parse.quote(state, safe='')}" if state else ""
+    def list(
+        self, state: Optional[str] = None, name: Optional[str] = None
+    ) -> list["Sandbox"]:
+        # Both filters are applied server-side, so finding a sandbox by the name
+        # you gave it does not mean paging the whole fleet and matching locally.
+        filters = [
+            (key, value)
+            for key, value in (("state", state), ("name", name))
+            if value
+        ]
+        query = "?" + urllib.parse.urlencode(filters) if filters else ""
         payload = self.request("GET", "/run-cloud/sandboxes" + query) or {}
         return [Sandbox(self, item) for item in payload.get("items", [])]
 
@@ -546,6 +557,21 @@ class Sandbox:
         )
         return self
 
+    def rename(self, name: str) -> "Sandbox":
+        """Relabel the sandbox.
+
+        The name is a label you own and the filter ``list(name=...)`` matches on,
+        so this is how a sandbox gets re-tagged without destroying it. Works in
+        any state but destroyed; an empty name clears the label. Names are not
+        unique and are capped at 128 characters.
+        """
+        self._data = self._client.request(
+            "POST",
+            f"/run-cloud/sandboxes/{urllib.parse.quote(self.id, safe='')}/name",
+            {"name": name},
+        )
+        return self
+
     def set_timeout(self, seconds: int) -> "Sandbox":
         self._data = self._client.request(
             "POST",

{runcloud_sdk-0.8.2 → runcloud_sdk-0.9.0/runcloud_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runcloud-sdk
-Version: 0.8.2
+Version: 0.9.0
 Summary: Python SDK for run.cloud, including sandbox-provider compatibility adapters
 Author: Newly
 License-Expression: Apache-2.0
@@ -62,6 +62,21 @@ finally:
 automation, set `RUN_CLOUD_API_KEY` and optionally `RUN_CLOUD_API_URL`, or pass
 `api_key` and `api_url` directly.
 
+A sandbox's name is a label you own: set it at create, change it later, and
+filter on it. Naming plus `resume` is how the same sandbox goes back to the same
+piece of work instead of booting a new one:
+
+```python
+matches = cloud.list(name=f"project-{project_id}")
+box = matches[0].resume() if matches else cloud.create(name=f"project-{project_id}")
+
+box.rename(f"project-{project_id}-v2")
+box.rename("")  # clears the label
+```
+
+Names are not unique and mean nothing to the platform, so check `state` on a
+match before using it. Renaming works in any state but `destroyed`.
+
 ## Compatibility adapters
 
 The same distribution includes migration adapters:

{runcloud_sdk-0.8.2 → runcloud_sdk-0.9.0}/tests/test_sdk.py

@@ -114,6 +114,35 @@ class SDKTests(unittest.TestCase):
             self.recorder.calls,
         )
 
+    def test_rename_posts_the_label_and_list_filters_on_it(self):
+        box = self.client.create()
+        box.rename("proj_42")
+        self.assertIn(
+            ("POST", "/run-cloud/sandboxes/sb_python/name", {"name": "proj_42"}),
+            self.recorder.calls,
+        )
+        # The response replaces the cached record, so the new name is readable
+        # without a second get().
+        self.assertEqual(box.name, "compat")
+
+        # An empty name clears the label rather than being rejected client-side.
+        box.rename("")
+        self.assertIn(
+            ("POST", "/run-cloud/sandboxes/sb_python/name", {"name": ""}),
+            self.recorder.calls,
+        )
+
+        self.client.list(name="proj_42")
+        self.assertIn(
+            ("GET", "/run-cloud/sandboxes?name=proj_42", None),
+            self.recorder.calls,
+        )
+        self.client.list(state="running", name="proj 42")
+        self.assertIn(
+            ("GET", "/run-cloud/sandboxes?state=running&name=proj+42", None),
+            self.recorder.calls,
+        )
+
     def test_exec_contract_defaults_legacy_true_and_preserves_false(self):
         for frame, expected in [
             ({"stream": "exit"}, 0),
@@ -338,7 +367,7 @@ class SDKTests(unittest.TestCase):
             Client(api_key="rc_live_test").request("GET", "/run-cloud/account")
 
         request = urlopen.call_args.args[0]
-        self.assertEqual(request.get_header("User-agent"), "runcloud-python/0.8.2")
+        self.assertEqual(request.get_header("User-agent"), "runcloud-python/0.8.3")
 
     def test_exec_stream_opens_authenticated_websocket_and_sends_command(self):
         session = WebSocketSession()
@@ -368,7 +397,7 @@ class SDKTests(unittest.TestCase):
         connect.assert_called_once_with(
             "wss://api.example.test/run-cloud/sandboxes/sb_1/exec/stream?mode=command",
             additional_headers={"Authorization": "Bearer rc_live_test"},
-            user_agent_header="runcloud-python/0.8.2",
+            user_agent_header="runcloud-python/0.8.3",
             open_timeout=60.0,
             close_timeout=5,
             max_size=8 << 20,
@@ -398,7 +427,12 @@ class CredentialTests(unittest.TestCase):
             clear=False,
         )
         self.environment.start()
-        for name in ("RUN_CLOUD_API_KEY", "RUN_CLOUD_API_TOKEN", "RUN_CLOUD_API_URL"):
+        for name in (
+            "RUN_CLOUD_API_KEY",
+            "RUN_CLOUD_API_TOKEN",
+            "RUN_CLOUD_CI_ENVIRONMENT_TOKEN",
+            "RUN_CLOUD_API_URL",
+        ):
             os.environ.pop(name, None)
 
     def tearDown(self):
@@ -458,6 +492,13 @@ class CredentialTests(unittest.TestCase):
         self.assertEqual(client.api_key, "environment-key")
         self.assertEqual(client.api_url, "https://api.run.cloud")
 
+    def test_ci_environment_capability_is_used_without_an_api_key(self):
+        os.environ["RUN_CLOUD_CI_ENVIRONMENT_TOKEN"] = "rce_environment"
+
+        client = Client()
+
+        self.assertEqual(client.api_key, "rce_environment")
+
     def test_api_url_override_applies_to_saved_login(self):
         self.save_credentials()
         os.environ["RUN_CLOUD_API_URL"] = "https://override.example/"