voidrun 0.1.0__tar.gz → 0.2.1__tar.gz

{voidrun-0.1.0 → voidrun-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: voidrun
-Version: 0.1.0
+Version: 0.2.1
 Summary: Python SDK for VoidRun AI Sandbox
 Project-URL: Homepage, https://voidrun.io
 Project-URL: Documentation, https://docs.voidrun.io
@@ -55,7 +55,7 @@ The high-level API is aligned with the official **TypeScript SDK** (`create_sand
 
 ## Features
 
-- **Sandbox lifecycle**: Create, list, fetch, start/stop/pause/resume, and remove sandboxes (sync and async).
+- **Sandbox lifecycle**: Create, list, fetch, start/sleep/wake (stop/pause→sleep, resume→wake), and remove sandboxes (sync and async).
 - **Shell execution**: synchronous `exec` with optional `ExecRequest` (no `background` flag); SSE streaming via `exec_stream`; detached processes via `.commands.run`.
 - **Code interpreter**: `run_code` / `interpreter.run` return a structured **`CodeExecutionResult`** (stdout, stderr, success, exit_code, results, logs).
 - **Files**: Create, upload, download, list, move, copy, compress, extract, permissions, search, disk usage.
@@ -130,15 +130,33 @@ from voidrun import VoidRun
 
 vr = VoidRun()  # uses VR_API_KEY; default base URL unless VR_API_URL / API_URL is set
 
-sandbox = vr.create_sandbox(mem=1024, cpu=1)
+sandbox = vr.create_sandbox(
+    mem=1024,
+    cpu=1,
+    labels={"env": "prod", "team": "api"},
+    publish_ports=[8080],  # expose ports as public URLs (set at create time only)
+)
 
 result = sandbox.exec('echo "Hello from VoidRun"')
 # Exec returns VoidRunResponse whose .data is ExecResponseData
 print(result.data.stdout)
+print(sandbox.labels)
+print(sandbox.publish_ports)
+
+# Public URLs are only available for ports declared at creation
+print(sandbox.get_public_urls())
+
+listed = vr.list_sandboxes(labels={"env": "prod"})
+print(listed.meta.total)
 
 sandbox.remove()
 ```
 
+`publish_ports` (alias `publishPorts`) must be set at creation to expose ports
+as public HTTPS URLs. Pass up to **4** ports (each `1–65535`, no duplicates);
+the created sandbox echoes them on `sandbox.publish_ports`. Ports not published
+at creation are not reachable via `get_public_urls()`.
+
 ### Async
 
 ```python
@@ -194,9 +212,9 @@ Use the same mental model as `@voidrun/sdk` (or the internal TS client):
 
 **Recommended methods**
 
-- `create_sandbox(...)` → `Sandbox`
+- `create_sandbox(...)` → `Sandbox` (optional `labels=`, `publish_ports=`)
 - `get_sandbox(sandbox_id)` → `Sandbox`
-- `list_sandboxes(page=..., limit=...)` → `ListSandboxesResult`
+- `list_sandboxes(page=..., limit=..., labels=...)` → `ListSandboxesResult`
 - `remove_sandbox(sandbox_id)` → `None`
 
 `AsyncVoidRun` exposes the same names with `await` and provides `aclose()` (and `async with` support) to shut down the thread pool used for API calls.
@@ -207,7 +225,7 @@ Create options accept both snake_case and camelCase where noted in code (e.g. `e
 
 ### `Sandbox`
 
-Notable attributes: `id`, `name`, `cpu`, `mem`, `org_id`, `status`, `env_vars`, `image`, `region`, `ref_id`, `auto_sleep`, `disk_mb`, `created_at`, `created_by`.
+Notable attributes: `id`, `name`, `cpu`, `mem`, `org_id`, `status`, `env_vars`, `image`, `region`, `ref_id`, `auto_sleep`, `disk_mb`, `labels`, `publish_ports`, `created_at`, `created_by`.
 
 Sub-clients:
 
@@ -218,7 +236,8 @@ Sub-clients:
 
 Lifecycle:
 
-- `start`, `stop`, `pause`, `resume` (and `*_async` variants where applicable)  
+- `start`, `sleep`, `wake` (and `*_async` variants)  
+- `stop` / `pause` alias `sleep`; `resume` aliases `wake`  
 - `remove()` / `remove_async()`: delete sandbox on the API  
 - `delete()` / `delete_async()`: deprecated aliases for `remove`  
 

{voidrun-0.1.0 → voidrun-0.2.1}/README.md

@@ -31,7 +31,7 @@ The high-level API is aligned with the official **TypeScript SDK** (`create_sand
 
 ## Features
 
-- **Sandbox lifecycle**: Create, list, fetch, start/stop/pause/resume, and remove sandboxes (sync and async).
+- **Sandbox lifecycle**: Create, list, fetch, start/sleep/wake (stop/pause→sleep, resume→wake), and remove sandboxes (sync and async).
 - **Shell execution**: synchronous `exec` with optional `ExecRequest` (no `background` flag); SSE streaming via `exec_stream`; detached processes via `.commands.run`.
 - **Code interpreter**: `run_code` / `interpreter.run` return a structured **`CodeExecutionResult`** (stdout, stderr, success, exit_code, results, logs).
 - **Files**: Create, upload, download, list, move, copy, compress, extract, permissions, search, disk usage.
@@ -106,15 +106,33 @@ from voidrun import VoidRun
 
 vr = VoidRun()  # uses VR_API_KEY; default base URL unless VR_API_URL / API_URL is set
 
-sandbox = vr.create_sandbox(mem=1024, cpu=1)
+sandbox = vr.create_sandbox(
+    mem=1024,
+    cpu=1,
+    labels={"env": "prod", "team": "api"},
+    publish_ports=[8080],  # expose ports as public URLs (set at create time only)
+)
 
 result = sandbox.exec('echo "Hello from VoidRun"')
 # Exec returns VoidRunResponse whose .data is ExecResponseData
 print(result.data.stdout)
+print(sandbox.labels)
+print(sandbox.publish_ports)
+
+# Public URLs are only available for ports declared at creation
+print(sandbox.get_public_urls())
+
+listed = vr.list_sandboxes(labels={"env": "prod"})
+print(listed.meta.total)
 
 sandbox.remove()
 ```
 
+`publish_ports` (alias `publishPorts`) must be set at creation to expose ports
+as public HTTPS URLs. Pass up to **4** ports (each `1–65535`, no duplicates);
+the created sandbox echoes them on `sandbox.publish_ports`. Ports not published
+at creation are not reachable via `get_public_urls()`.
+
 ### Async
 
 ```python
@@ -170,9 +188,9 @@ Use the same mental model as `@voidrun/sdk` (or the internal TS client):
 
 **Recommended methods**
 
-- `create_sandbox(...)` → `Sandbox`
+- `create_sandbox(...)` → `Sandbox` (optional `labels=`, `publish_ports=`)
 - `get_sandbox(sandbox_id)` → `Sandbox`
-- `list_sandboxes(page=..., limit=...)` → `ListSandboxesResult`
+- `list_sandboxes(page=..., limit=..., labels=...)` → `ListSandboxesResult`
 - `remove_sandbox(sandbox_id)` → `None`
 
 `AsyncVoidRun` exposes the same names with `await` and provides `aclose()` (and `async with` support) to shut down the thread pool used for API calls.
@@ -183,7 +201,7 @@ Create options accept both snake_case and camelCase where noted in code (e.g. `e
 
 ### `Sandbox`
 
-Notable attributes: `id`, `name`, `cpu`, `mem`, `org_id`, `status`, `env_vars`, `image`, `region`, `ref_id`, `auto_sleep`, `disk_mb`, `created_at`, `created_by`.
+Notable attributes: `id`, `name`, `cpu`, `mem`, `org_id`, `status`, `env_vars`, `image`, `region`, `ref_id`, `auto_sleep`, `disk_mb`, `labels`, `publish_ports`, `created_at`, `created_by`.
 
 Sub-clients:
 
@@ -194,7 +212,8 @@ Sub-clients:
 
 Lifecycle:
 
-- `start`, `stop`, `pause`, `resume` (and `*_async` variants where applicable)  
+- `start`, `sleep`, `wake` (and `*_async` variants)  
+- `stop` / `pause` alias `sleep`; `resume` aliases `wake`  
 - `remove()` / `remove_async()`: delete sandbox on the API  
 - `delete()` / `delete_async()`: deprecated aliases for `remove`  
 

{voidrun-0.1.0 → voidrun-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "voidrun"
-version = "0.1.0"
+version = "0.2.1"
 description = "Python SDK for VoidRun AI Sandbox"
 readme = "README.md"
 requires-python = ">=3.9"

{voidrun-0.1.0 → voidrun-0.2.1}/voidrun/api_client/api/execution_api.py

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 """
     VoidRun API
 
@@ -11,6 +9,7 @@
     Do not edit the class manually.
 """  # noqa: E501
 
+
 import warnings
 from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union

{voidrun-0.1.0 → voidrun-0.2.1}/voidrun/api_client/api/file_system_api.py

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 """
     VoidRun API
 
@@ -11,6 +9,7 @@
     Do not edit the class manually.
 """  # noqa: E501
 
+
 import warnings
 from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
@@ -2146,7 +2145,7 @@ class FileSystemApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> bytearray:
+    ) -> bytes:
         """Download file
 
         Download a file from the sandbox
@@ -2187,7 +2186,7 @@ class FileSystemApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "bytearray",
+            '200': "bytes",
             '401': "ErrorResponse",
             '404': "ErrorResponse",
         }
@@ -2219,7 +2218,7 @@ class FileSystemApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[bytearray]:
+    ) -> ApiResponse[bytes]:
         """Download file
 
         Download a file from the sandbox
@@ -2260,7 +2259,7 @@ class FileSystemApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "bytearray",
+            '200': "bytes",
             '401': "ErrorResponse",
             '404': "ErrorResponse",
         }
@@ -2333,7 +2332,7 @@ class FileSystemApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "bytearray",
+            '200': "bytes",
             '401': "ErrorResponse",
             '404': "ErrorResponse",
         }
@@ -4814,7 +4813,7 @@ class FileSystemApi:
         :param path: (required)
         :type path: str
         :param body: (required)
-        :type body: bytearray
+        :type body: bytes
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -4891,7 +4890,7 @@ class FileSystemApi:
         :param path: (required)
         :type path: str
         :param body: (required)
-        :type body: bytearray
+        :type body: bytes
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -4968,7 +4967,7 @@ class FileSystemApi:
         :param path: (required)
         :type path: str
         :param body: (required)
-        :type body: bytearray
+        :type body: bytes
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of

{voidrun-0.1.0 → voidrun-0.2.1}/voidrun/api_client/api/images_api.py

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 """
     VoidRun API
 
@@ -11,6 +9,7 @@
     Do not edit the class manually.
 """  # noqa: E501
 
+
 import warnings
 from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
@@ -590,7 +589,7 @@ class ImagesApi:
     ) -> List[Image]:
         """List images
 
-        Get all available base images
+        Get active base images visible to the organization (inactive or superseded images are omitted)
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -654,7 +653,7 @@ class ImagesApi:
     ) -> ApiResponse[List[Image]]:
         """List images
 
-        Get all available base images
+        Get active base images visible to the organization (inactive or superseded images are omitted)
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -718,7 +717,7 @@ class ImagesApi:
     ) -> RESTResponseType:
         """List images
 
-        Get all available base images
+        Get active base images visible to the organization (inactive or superseded images are omitted)
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

{voidrun-0.1.0 → voidrun-0.2.1}/voidrun/api_client/api/organizations_api.py

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 """
     VoidRun API
 
@@ -11,6 +9,7 @@
     Do not edit the class manually.
 """  # noqa: E501
 
+
 import warnings
 from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union