CoreWeave Sandbox Python Client

Warnings

• gotcha Authentication to the CoreWeave platform is required. The `cwsandbox` client relies on proper configuration, often via environment variables (e.g., `COREWEAVE_API_KEY`, `COREWEAVE_PROJECT_ID`) or a configured CoreWeave CLI/SDK context. The provided quickstart assumes this setup.
  Fix: Ensure `COREWEAVE_API_KEY` and `COREWEAVE_PROJECT_ID` (or equivalent CoreWeave client configuration) are correctly set in your environment before using the library. Refer to CoreWeave's official authentication documentation for details.
• gotcha The term 'cwsandbox' in this context refers to a client for CoreWeave's remote sandboxing service, not a local Python-level sandbox for executing untrusted Python code. Misunderstanding this distinction can lead to incorrect security assumptions if you intend to sandbox local Python execution.
  Fix: Understand that `cwsandbox` is an API client for managing remote execution environments provided by CoreWeave. If you need to sandbox Python code locally, consider dedicated Python sandboxing tools or OS-level isolation (e.g., containers).
• gotcha Failing to explicitly stop sandboxes (`sb.stop()`) can lead to resource leakage and unexpected billing, as sandbox instances on the CoreWeave platform may continue to run if not properly terminated.
  Fix: Always ensure that `sb.stop()` is called for any `Sandbox` instance you create, ideally within a `try...finally` block or by using a context manager if available, to guarantee resource cleanup.
• deprecated The `Sandbox.run` factory method provides a hybrid synchronous/asynchronous API (`.result()` blocks). While convenient, mixing sync and async code can be a footgun. Older versions or alternative methods might have different blocking behaviors.
  Fix: For robust asynchronous applications, consult the official documentation (if available) for native async methods (e.g., `await Sandbox.arun()`, `await sb.astop()`) to avoid blocking the event loop. For synchronous applications, ensure you understand where blocking operations occur.

Install

• pip install cwsandbox Install with pip

Imports

• Sandbox

  from cwsandbox import Sandbox

Quickstart

This quickstart demonstrates how to create and run a simple command within a CoreWeave Sandbox using the `cwsandbox` client library. It highlights the use of `Sandbox.run` to initiate a sandbox and `sb.stop().result()` to wait for its completion and retrieve the output. Authentication typically relies on environment variables or a configured CoreWeave client.

import os
from cwsandbox import Sandbox

# Ensure COREWEAVE_API_KEY and COREWEAVE_PROJECT_ID (or similar) are set in your environment
# For demonstration, using dummy values. In production, use actual credentials.
# os.environ['COREWEAVE_API_KEY'] = os.environ.get('CWSANDBOX_API_KEY', 'your_api_key_here')
# os.environ['COREWEAVE_PROJECT_ID'] = os.environ.get('CWSANDBOX_PROJECT_ID', 'your_project_id_here')

try:
    # Create and run a simple command in a sandbox
    print("Starting sandbox...")
    sb = Sandbox.run("echo", "Hello, World! from cwsandbox")
    print(f"Sandbox ID: {sb.id}")

    # Wait for the sandbox to complete and get results (synchronous wait)
    result = sb.stop().result()
    print("Sandbox output:")
    print(result.output)
    print(f"Sandbox exited with code: {result.exit_code}")

except Exception as e:
    print(f"An error occurred: {e}")
    print("Ensure your CoreWeave environment is configured and authenticated.")