voidrun 0.0.1__tar.gz → 0.0.2__tar.gz

voidrun-0.0.2/PKG-INFO

@@ -0,0 +1,214 @@
+Metadata-Version: 2.4
+Name: voidrun
+Version: 0.0.2
+Summary: Python SDK for VoidRun AI Sandbox
+Project-URL: Homepage, https://voidrun.io
+Project-URL: Documentation, https://docs.voidrun.io
+Project-URL: Repository, https://github.com/voidrun/py-sdk
+Author-email: VoidRun Team <support@voidrun.io>
+License-Expression: MIT
+Classifier: Framework :: AsyncIO
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: certifi
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: typing-extensions>=4.0.0
+Requires-Dist: urllib3>=2.0.0
+Requires-Dist: websockets>=11.0
+Description-Content-Type: text/markdown
+
+# VoidRun Python SDK
+
+Python SDK for interacting with VoidRun AI Sandboxes. Create sandboxes, execute commands, manage files, watch changes, and use interactive PTY sessions.
+
+[![PyPI version](https://img.shields.io/pypi/v/voidrun)](https://pypi.org/project/voidrun/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- Sandbox lifecycle management
+- Command execution with stdout/stderr capture
+- File system operations (upload, download, list, copy, move)
+- File watching via WebSocket
+- PTY sessions (ephemeral and persistent)
+- Code interpreter helper for common languages
+- Sync and async clients
+
+## Installation
+
+With pip:
+
+```bash
+pip install voidrun
+```
+
+With Poetry:
+
+```bash
+poetry add voidrun
+```
+
+## Quick Start (Sync)
+
+Set your API key:
+
+```bash
+export VR_API_KEY="your-api-key"
+```
+
+Basic usage:
+
+```python
+from voidrun import VoidRun
+
+vr = VoidRun()
+
+resp = vr.sandboxes.create(mem=1024, cpu=1)
+sandbox = resp.data
+
+exec_resp = sandbox.exec('echo "Hello from VoidRun"')
+print(exec_resp.data.data.stdout)
+
+sandbox.delete()
+```
+
+## Quick Start (Async)
+
+```python
+import asyncio
+from voidrun import AsyncVoidRun
+
+
+async def main():
+    vr = AsyncVoidRun()
+    resp = await vr.sandboxes.create(mem=1024, cpu=1)
+    sandbox = resp.data
+
+    exec_resp = sandbox.exec('echo "Hello from VoidRun"')
+    print(exec_resp.data.data.stdout)
+
+    await sandbox.delete_async()
+    await vr.aclose()
+
+
+asyncio.run(main())
+```
+
+## Core Operations
+
+### Sandboxes
+
+```python
+resp = vr.sandboxes.list()
+sandboxes = resp.data
+
+resp = vr.sandboxes.get("sandbox-id")
+existing = resp.data
+
+vr.sandboxes.delete("sandbox-id")
+```
+
+### Command Execution
+
+```python
+result = sandbox.exec("ls -la /home")
+print(result.data.data.stdout)
+print(result.data.data.stderr)
+print(result.data.data.exit_code)
+```
+
+### Streaming Execution
+
+```python
+def on_stdout(data):
+    print("STDOUT:", data)
+
+
+def on_stderr(data):
+    print("STDERR:", data)
+
+
+sandbox.exec_stream(
+    "python3 -c 'print(2 + 2)'",
+    on_stdout=on_stdout,
+    on_stderr=on_stderr,
+)
+```
+
+### Code Interpreter
+
+```python
+resp = sandbox.run_code("print(2 + 2)", language="python")
+print(resp.data.stdout)
+```
+
+### File Operations
+
+```python
+sandbox.fs.create_file("/tmp/hello.txt")
+sandbox.fs.upload_file("/tmp/hello.txt", "Hello, World!")
+
+data = sandbox.fs.download_file("/tmp/hello.txt")
+print(data.decode("utf-8"))
+
+files = sandbox.fs.list_files("/tmp")
+print(files.data)
+```
+
+### File Watching (Async)
+
+```python
+async def watch_tmp():
+    watcher = await sandbox.fs.watch(
+        "/tmp",
+        recursive=True,
+        on_event=lambda evt: print("event:", evt),
+        on_error=lambda err: print("watch error:", err),
+    )
+
+    # Stop watching when done
+    watcher.close()
+```
+
+### PTY Sessions (Async)
+
+```python
+session_resp = sandbox.pty.create_session()
+session_id = session_resp.data.data.session_id
+
+pty = await sandbox.pty.connect(
+    session_id=session_id,
+    on_data=lambda data: print(data, end=""),
+)
+
+pty.send_input("echo 'hello'\n")
+await pty.close()
+```
+
+## Configuration
+
+Environment variables:
+
+```bash
+export VR_API_KEY="your-api-key"
+export VOIDRUN_BASE_URL="https://api.voidrun.io"
+```
+
+You can also pass `api_key` and `base_url` directly:
+
+```python
+vr = VoidRun(api_key="...", base_url="https://api.voidrun.io")
+```
+
+## Examples
+
+See the examples in [py-sdk/examples](py-sdk/examples).
+
+## License
+
+MIT License

voidrun-0.0.2/README.md

@@ -0,0 +1,190 @@
+# VoidRun Python SDK
+
+Python SDK for interacting with VoidRun AI Sandboxes. Create sandboxes, execute commands, manage files, watch changes, and use interactive PTY sessions.
+
+[![PyPI version](https://img.shields.io/pypi/v/voidrun)](https://pypi.org/project/voidrun/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- Sandbox lifecycle management
+- Command execution with stdout/stderr capture
+- File system operations (upload, download, list, copy, move)
+- File watching via WebSocket
+- PTY sessions (ephemeral and persistent)
+- Code interpreter helper for common languages
+- Sync and async clients
+
+## Installation
+
+With pip:
+
+```bash
+pip install voidrun
+```
+
+With Poetry:
+
+```bash
+poetry add voidrun
+```
+
+## Quick Start (Sync)
+
+Set your API key:
+
+```bash
+export VR_API_KEY="your-api-key"
+```
+
+Basic usage:
+
+```python
+from voidrun import VoidRun
+
+vr = VoidRun()
+
+resp = vr.sandboxes.create(mem=1024, cpu=1)
+sandbox = resp.data
+
+exec_resp = sandbox.exec('echo "Hello from VoidRun"')
+print(exec_resp.data.data.stdout)
+
+sandbox.delete()
+```
+
+## Quick Start (Async)
+
+```python
+import asyncio
+from voidrun import AsyncVoidRun
+
+
+async def main():
+    vr = AsyncVoidRun()
+    resp = await vr.sandboxes.create(mem=1024, cpu=1)
+    sandbox = resp.data
+
+    exec_resp = sandbox.exec('echo "Hello from VoidRun"')
+    print(exec_resp.data.data.stdout)
+
+    await sandbox.delete_async()
+    await vr.aclose()
+
+
+asyncio.run(main())
+```
+
+## Core Operations
+
+### Sandboxes
+
+```python
+resp = vr.sandboxes.list()
+sandboxes = resp.data
+
+resp = vr.sandboxes.get("sandbox-id")
+existing = resp.data
+
+vr.sandboxes.delete("sandbox-id")
+```
+
+### Command Execution
+
+```python
+result = sandbox.exec("ls -la /home")
+print(result.data.data.stdout)
+print(result.data.data.stderr)
+print(result.data.data.exit_code)
+```
+
+### Streaming Execution
+
+```python
+def on_stdout(data):
+    print("STDOUT:", data)
+
+
+def on_stderr(data):
+    print("STDERR:", data)
+
+
+sandbox.exec_stream(
+    "python3 -c 'print(2 + 2)'",
+    on_stdout=on_stdout,
+    on_stderr=on_stderr,
+)
+```
+
+### Code Interpreter
+
+```python
+resp = sandbox.run_code("print(2 + 2)", language="python")
+print(resp.data.stdout)
+```
+
+### File Operations
+
+```python
+sandbox.fs.create_file("/tmp/hello.txt")
+sandbox.fs.upload_file("/tmp/hello.txt", "Hello, World!")
+
+data = sandbox.fs.download_file("/tmp/hello.txt")
+print(data.decode("utf-8"))
+
+files = sandbox.fs.list_files("/tmp")
+print(files.data)
+```
+
+### File Watching (Async)
+
+```python
+async def watch_tmp():
+    watcher = await sandbox.fs.watch(
+        "/tmp",
+        recursive=True,
+        on_event=lambda evt: print("event:", evt),
+        on_error=lambda err: print("watch error:", err),
+    )
+
+    # Stop watching when done
+    watcher.close()
+```
+
+### PTY Sessions (Async)
+
+```python
+session_resp = sandbox.pty.create_session()
+session_id = session_resp.data.data.session_id
+
+pty = await sandbox.pty.connect(
+    session_id=session_id,
+    on_data=lambda data: print(data, end=""),
+)
+
+pty.send_input("echo 'hello'\n")
+await pty.close()
+```
+
+## Configuration
+
+Environment variables:
+
+```bash
+export VR_API_KEY="your-api-key"
+export VOIDRUN_BASE_URL="https://api.voidrun.io"
+```
+
+You can also pass `api_key` and `base_url` directly:
+
+```python
+vr = VoidRun(api_key="...", base_url="https://api.voidrun.io")
+```
+
+## Examples
+
+See the examples in [py-sdk/examples](py-sdk/examples).
+
+## License
+
+MIT License

{voidrun-0.0.1 → voidrun-0.0.2}/pyproject.toml

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

{voidrun-0.0.1 → voidrun-0.0.2}/voidrun/api_client/__init__.py

@@ -3,9 +3,9 @@
 # flake8: noqa
 
 """
-    Hyper Fleet Native API
+    VoidRun API
 
-    Hyper Fleet Native API provides comprehensive management of virtual machines (sandboxes),  file system operations, execution environments, and organizational resources.  All endpoints except `/api/register` require the `X-API-Key` header for authentication. 
+    VoidRun API provides comprehensive management of virtual machines (sandboxes),  file system operations, execution environments, and organizational resources.  All endpoints except `/api/register` and `/api/version` require the `X-API-Key` header for authentication. 
 
     The version of the OpenAPI document: 1.0.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -24,6 +24,7 @@ __all__ = [
     "ImagesApi",
     "OrganizationsApi",
     "SandboxesApi",
+    "SystemApi",
     "ApiResponse",
     "ApiClient",
     "Configuration",
@@ -34,6 +35,7 @@ __all__ = [
     "ApiAttributeError",
     "ApiException",
     "APIKeyResponse",
+    "ActivateAPIKeyRequest",
     "ApiResponseSandbox",
     "ApiResponseSandboxesList",
     "ApiResponseSandboxesListMeta",
@@ -61,8 +63,11 @@ __all__ = [
     "FileStats",
     "GenerateAPIKeyRequest",
     "GeneratedAPIKeyResponse",
+    "GetOrgUsers200Response",
+    "GetOrgUsers200ResponseAllOfDataInner",
     "GetPTYBuffer200Response",
     "GetPTYBuffer200ResponseAllOfData",
+    "GetVersion200Response",
     "Image",
     "KillBackgroundProcessRequest",
     "ListFiles200Response",
@@ -79,6 +84,9 @@ __all__ = [
     "RestoreSandboxRequest",
     "RunBackgroundCommandRequest",
     "Sandbox",
+    "SessionExecRequest",
+    "SessionExecResponse",
+    "SessionExecStreamRequest",
     "Snapshot",
     "StartWatch200Response",
     "StartWatch200ResponseData",
@@ -93,6 +101,7 @@ from voidrun.api_client.api.file_system_api import FileSystemApi as FileSystemAp
 from voidrun.api_client.api.images_api import ImagesApi as ImagesApi
 from voidrun.api_client.api.organizations_api import OrganizationsApi as OrganizationsApi
 from voidrun.api_client.api.sandboxes_api import SandboxesApi as SandboxesApi
+from voidrun.api_client.api.system_api import SystemApi as SystemApi
 
 # import ApiClient
 from voidrun.api_client.api_response import ApiResponse as ApiResponse
@@ -107,6 +116,7 @@ from voidrun.api_client.exceptions import ApiException as ApiException
 
 # import models into sdk package
 from voidrun.api_client.models.api_key_response import APIKeyResponse as APIKeyResponse
+from voidrun.api_client.models.activate_api_key_request import ActivateAPIKeyRequest as ActivateAPIKeyRequest
 from voidrun.api_client.models.api_response_sandbox import ApiResponseSandbox as ApiResponseSandbox
 from voidrun.api_client.models.api_response_sandboxes_list import ApiResponseSandboxesList as ApiResponseSandboxesList
 from voidrun.api_client.models.api_response_sandboxes_list_meta import ApiResponseSandboxesListMeta as ApiResponseSandboxesListMeta
@@ -134,8 +144,11 @@ from voidrun.api_client.models.file_info import FileInfo as FileInfo
 from voidrun.api_client.models.file_stats import FileStats as FileStats
 from voidrun.api_client.models.generate_api_key_request import GenerateAPIKeyRequest as GenerateAPIKeyRequest
 from voidrun.api_client.models.generated_api_key_response import GeneratedAPIKeyResponse as GeneratedAPIKeyResponse
+from voidrun.api_client.models.get_org_users200_response import GetOrgUsers200Response as GetOrgUsers200Response
+from voidrun.api_client.models.get_org_users200_response_all_of_data_inner import GetOrgUsers200ResponseAllOfDataInner as GetOrgUsers200ResponseAllOfDataInner
 from voidrun.api_client.models.get_pty_buffer200_response import GetPTYBuffer200Response as GetPTYBuffer200Response
 from voidrun.api_client.models.get_pty_buffer200_response_all_of_data import GetPTYBuffer200ResponseAllOfData as GetPTYBuffer200ResponseAllOfData
+from voidrun.api_client.models.get_version200_response import GetVersion200Response as GetVersion200Response
 from voidrun.api_client.models.image import Image as Image
 from voidrun.api_client.models.kill_background_process_request import KillBackgroundProcessRequest as KillBackgroundProcessRequest
 from voidrun.api_client.models.list_files200_response import ListFiles200Response as ListFiles200Response
@@ -152,6 +165,9 @@ from voidrun.api_client.models.resize_terminal_request import ResizeTerminalRequ
 from voidrun.api_client.models.restore_sandbox_request import RestoreSandboxRequest as RestoreSandboxRequest
 from voidrun.api_client.models.run_background_command_request import RunBackgroundCommandRequest as RunBackgroundCommandRequest
 from voidrun.api_client.models.sandbox import Sandbox as Sandbox
+from voidrun.api_client.models.session_exec_request import SessionExecRequest as SessionExecRequest
+from voidrun.api_client.models.session_exec_response import SessionExecResponse as SessionExecResponse
+from voidrun.api_client.models.session_exec_stream_request import SessionExecStreamRequest as SessionExecStreamRequest
 from voidrun.api_client.models.snapshot import Snapshot as Snapshot
 from voidrun.api_client.models.start_watch200_response import StartWatch200Response as StartWatch200Response
 from voidrun.api_client.models.start_watch200_response_data import StartWatch200ResponseData as StartWatch200ResponseData

{voidrun-0.0.1 → voidrun-0.0.2}/voidrun/api_client/api/__init__.py

@@ -7,4 +7,5 @@ from voidrun.api_client.api.file_system_api import FileSystemApi
 from voidrun.api_client.api.images_api import ImagesApi
 from voidrun.api_client.api.organizations_api import OrganizationsApi
 from voidrun.api_client.api.sandboxes_api import SandboxesApi
+from voidrun.api_client.api.system_api import SystemApi
 

{voidrun-0.0.1 → voidrun-0.0.2}/voidrun/api_client/api/authentication_api.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Hyper Fleet Native API
+    VoidRun API
 
-    Hyper Fleet Native API provides comprehensive management of virtual machines (sandboxes),  file system operations, execution environments, and organizational resources.  All endpoints except `/api/register` require the `X-API-Key` header for authentication. 
+    VoidRun API provides comprehensive management of virtual machines (sandboxes),  file system operations, execution environments, and organizational resources.  All endpoints except `/api/register` and `/api/version` require the `X-API-Key` header for authentication. 
 
     The version of the OpenAPI document: 1.0.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)