scalebox-sdk 0.1.14__py3-none-any.whl → 0.1.15__py3-none-any.whl

{scalebox_sdk-0.1.14.dist-info → scalebox_sdk-0.1.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scalebox-sdk
-Version: 0.1.14
+Version: 0.1.15
 Summary: ScaleBox Python SDK - A multi-language code execution sandbox with Python, R, Node.js, Deno/TypeScript, Java, and Bash support
 Author-email: ScaleBox Team <dev@scalebox.dev>
 Maintainer-email: ScaleBox Team <dev@scalebox.dev>
@@ -68,66 +68,68 @@ Dynamic: license-file
 [![Import Sorting: isort](https://img.shields.io/badge/imports-isort-blue.svg)](https://pycqa.github.io/isort/)
 [![Multi-Language Support](https://img.shields.io/badge/languages-Python%20%7C%20R%20%7C%20Node.js%20%7C%20TypeScript%20%7C%20Java%20%7C%20Bash-orange.svg)](https://github.com/scalebox-dev/scalebox-sdk-python)
 
-一个用于在可控沙箱中执行多语言代码的 Python SDK，支持同步与异步模式，以及多语言 Kernel（Python、R、Node.js、Deno/TypeScript、Java/IJAVA、Bash）。已提供全面的真实环境测试用例与脚本。
+> [中文文档](./README_CN.md)
 
-## 功能特性
-- 多语言内核：Python、R、Node.js、Deno/TypeScript、Java/IJAVA、Bash
-- 同步 `Sandbox` 与异步 `AsyncSandbox` 执行
-- 持久上下文：跨多次执行保留变量/状态
-- 回调订阅：stdout、stderr、结果与错误
-- 丰富结果格式：text、html、markdown、svg、png、jpeg、pdf、latex、json、javascript、chart、data 等
-- 真实环境测试：覆盖同步/异步与多语言示例
+A Python SDK for executing multi-language code in a controlled sandbox environment, supporting both synchronous and asynchronous modes, along with multi-language kernels (Python, R, Node.js, Deno/TypeScript, Java/IJAVA, Bash). Comprehensive real-world test cases and scripts are provided.
 
-## 环境要求
+## Features
+- **Multi-language kernels**: Python, R, Node.js, Deno/TypeScript, Java/IJAVA, Bash
+- **Execution modes**: Synchronous `Sandbox` and asynchronous `AsyncSandbox`
+- **Persistent context**: Retain variables/state across multiple executions
+- **Callback subscriptions**: stdout, stderr, results, and errors
+- **Rich result formats**: text, html, markdown, svg, png, jpeg, pdf, latex, json, javascript, chart, data, and more
+- **Real-world testing**: Comprehensive test coverage for sync/async and multi-language examples
+
+## Requirements
 - Python 3.12+
-- 可访问的 Scalebox 环境或本地服务
+- Accessible Scalebox environment or local service
 
-## 安装
+## Installation
 
 ```bash
-# 克隆项目
+# Clone the repository
 git clone https://github.com/scalebox-dev/scalebox-sdk-python.git
 cd scalebox-sdk-python
 
-# 建议使用虚拟环境
+# Recommended: use a virtual environment
 python3 -m venv venv
 source venv/bin/activate
 
-# 安装依赖
+# Install dependencies
 pip install -r scalebox/requirements.txt
 ```
 
-如果你以源码方式直接使用包（非 pip 安装），请将 `scalebox` 目录加入 Python 路径或复制到 venv 的 site-packages：
+If you're using the package directly from source (not via pip), add the `scalebox` directory to your Python path or copy it to your venv's site-packages:
 ```bash
 cp -r scalebox venv/lib/python3.12/site-packages/
 ```
 
-## 配置
-支持从环境变量或 `.env` 文件读取凭据：
+## Configuration
+Credentials can be read from environment variables or a `.env` file:
 
 - `SBX_API_KEY`
 
-示例：
+Example:
 ```env
 # .env
 SBX_API_KEY=***
 ```
-或：
+Or:
 ```bash
 export SBX_API_KEY=***
 ```
 
-可选：使用 `python-dotenv` 自动加载 `.env`：
+Optional: Use `python-dotenv` to automatically load `.env`:
 ```bash
 pip install python-dotenv
 ```
 
-## 快速开始（同步）
+## Quick Start (Synchronous)
 ```python
 from dotenv import load_dotenv; load_dotenv()
 from scalebox.code_interpreter import Sandbox
 
-sandbox = Sandbox.create()  # 默认生存期 5 分钟
+sandbox = Sandbox.create()  # Default lifetime: 5 minutes
 execution = sandbox.run_code("print('hello world')", language="python")
 print(execution.logs.stdout)
 
@@ -135,7 +137,7 @@ files = sandbox.files.list("/")
 print(files)
 ```
 
-## 快速开始（异步）
+## Quick Start (Asynchronous)
 ```python
 import asyncio
 from dotenv import load_dotenv; load_dotenv()
@@ -149,15 +151,15 @@ async def main():
 asyncio.run(main())
 ```
 
-## 多语言示例
-- Python：`language="python"`
-- R：`language="r"`
-- Node.js：`language="nodejs"`
-- Deno/TypeScript：`language="typescript"`
-- Java（IJAVA/纯Java）：`language="ijava"` 或 `language="java"`
-- Bash：`language="bash"`
+## Multi-Language Examples
+- Python: `language="python"`
+- R: `language="r"`
+- Node.js: `language="nodejs"`
+- Deno/TypeScript: `language="typescript"`
+- Java (IJAVA/pure Java): `language="ijava"` or `language="java"`
+- Bash: `language="bash"`
 
-示例（Node.js）：
+### Node.js Example:
 ```python
 from scalebox.code_interpreter import Sandbox
 sbx = Sandbox.create()
@@ -169,7 +171,7 @@ result = sbx.run_code(code, language="nodejs")
 print(result.logs.stdout)
 ```
 
-示例（R）：
+### R Example:
 ```python
 from scalebox.code_interpreter import Sandbox
 sbx = Sandbox.create()
@@ -182,7 +184,7 @@ res = sbx.run_code(code, language="r")
 print(res.logs.stdout)
 ```
 
-示例（Deno/TypeScript）：
+### Deno/TypeScript Example:
 ```python
 from scalebox.code_interpreter import Sandbox
 sbx = Sandbox.create()
@@ -195,7 +197,7 @@ res = sbx.run_code(ts, language="typescript")
 print(res.logs.stdout)
 ```
 
-示例（Java/IJAVA）：
+### Java/IJAVA Example:
 ```python
 from scalebox.code_interpreter import Sandbox
 sbx = Sandbox.create()
@@ -207,7 +209,7 @@ res = sbx.run_code(code, language="java")
 print(res.logs.stdout)
 ```
 
-示例（Bash）：
+### Bash Example:
 ```python
 from scalebox.code_interpreter import Sandbox
 sbx = Sandbox.create()
@@ -215,8 +217,8 @@ res = sbx.run_code("echo 'Hello from Bash'", language="bash")
 print(res.logs.stdout)
 ```
 
-## 上下文管理（Context）
-上下文允许跨多次执行复用变量/状态：
+## Context Management
+Context allows you to reuse variables/state across multiple executions:
 ```python
 from scalebox.code_interpreter import Sandbox
 sbx = Sandbox.create()
@@ -224,10 +226,11 @@ ctx = sbx.create_code_context(language="python", cwd="/tmp")
 
 sbx.run_code("counter = 0", context=ctx)
 sbx.run_code("counter += 1; print(counter)", context=ctx)
-# 使用完必须清理
+# Must clean up when done
 sbx.destroy_context(ctx)
 ```
-异步 API：
+
+Async API:
 ```python
 from scalebox.code_interpreter import AsyncSandbox
 
@@ -239,7 +242,7 @@ async def demo():
     await sbx.destroy_context(ctx)
 ```
 
-## 回调（可选）
+## Callbacks (Optional)
 ```python
 from scalebox.code_interpreter import Sandbox
 from scalebox.code_interpreter import OutputMessage, Result, ExecutionError
@@ -268,109 +271,109 @@ sbx.run_code(
 )
 ```
 
-## 结果格式（Result）
-`Result` 可能包含如下数据字段：
+## Result Formats
+`Result` may contain the following data fields:
 - `text`, `html`, `markdown`, `svg`, `png`, `jpeg`, `pdf`, `latex`
 - `json_data`, `javascript`, `data`, `chart`
 - `execution_count`, `is_main_result`, `extra`
 
-可以通过 `list(result.formats())` 查看可用格式。
+Use `list(result.formats())` to view available formats.
 
-## 运行测试
-项目 `test/` 目录包含全面的真实环境用例（非 unittest，直接脚本风格），覆盖：
-- 同步与异步综合用例
-- 多语言内核（Python、R、Node.js、Deno/TypeScript、Java/IJAVA、Bash）
-- 上下文管理、回调与结果格式
+## Running Tests
+The `test/` directory contains comprehensive real-world use cases (not unittest-style, direct script-style), covering:
+- Synchronous and asynchronous comprehensive test cases
+- Multi-language kernels (Python, R, Node.js, Deno/TypeScript, Java/IJAVA, Bash)
+- Context management, callbacks, and result formats
 
-运行语法检查：
+Run syntax checks:
 ```bash
 cd test
 python3 -m py_compile test_code_interpreter_sync_comprehensive.py
 python3 -m py_compile test_code_interpreter_async_comprehensive.py
 ```
 
-建议在虚拟环境中准备依赖并按需安装语言运行时（如 R、Node、Deno、JDK/IJAVA 等），确保各内核能够被后端执行。
+It's recommended to prepare dependencies in a virtual environment and install language runtimes (such as R, Node, Deno, JDK/IJAVA, etc.) as needed, ensuring each kernel can be executed by the backend.
 
-## 版本管理（Version Management）
+## Version Management
 
-本项目使用自动化版本管理，支持语义化版本控制（Semantic Versioning）。
+This project uses automated version management with support for Semantic Versioning.
 
-### 🚀 自动版本升级
+### 🚀 Automatic Version Bumping
 
-使用内置脚本进行版本升级：
+Use the built-in script to bump versions:
 
 ```bash
-# 升级补丁版本 (0.1.1 -> 0.1.2)
+# Bump patch version (0.1.1 -> 0.1.2)
 python scripts/bump_version.py patch
 
-# 升级次要版本 (0.1.1 -> 0.2.0)
+# Bump minor version (0.1.1 -> 0.2.0)
 python scripts/bump_version.py minor
 
-# 升级主要版本 (0.1.1 -> 1.0.0)
+# Bump major version (0.1.1 -> 1.0.0)
 python scripts/bump_version.py major
 ```
 
-### 📦 自动发布流程
+### 📦 Automated Release Process
 
-#### 🚀 方法1：GitHub Actions 一键升级（推荐）
+#### 🚀 Method 1: GitHub Actions One-Click Bump (Recommended)
 
-1. **进入 GitHub Actions 页面**
-2. **选择 "CI/CD Pipeline" workflow**
-3. **点击 "Run workflow" 按钮**
-4. **选择版本类型**：
-   - `patch`: 补丁版本 (0.1.1 → 0.1.2)
-   - `minor`: 次要版本 (0.1.1 → 0.2.0)  
-   - `major`: 主要版本 (0.1.1 → 1.0.0)
-5. **选择自动提交选项**
-6. **点击运行** - 系统会自动完成所有步骤！
+1. **Navigate to GitHub Actions page**
+2. **Select "CI/CD Pipeline" workflow**
+3. **Click "Run workflow" button**
+4. **Select version type**:
+   - `patch`: Patch version (0.1.1 → 0.1.2)
+   - `minor`: Minor version (0.1.1 → 0.2.0)  
+   - `major`: Major version (0.1.1 → 1.0.0)
+5. **Select auto-commit option**
+6. **Click run** - The system will automatically complete all steps!
 
-#### 🔧 方法2：本地脚本升级
+#### 🔧 Method 2: Local Script Bump
 
-1. **版本升级**：使用 `bump_version.py` 脚本
-2. **GitHub Actions**：自动构建和发布到PyPI
-3. **触发条件**：
-   - 推送到 `main` 分支
-   - 创建 `v*` 标签（如 `v0.1.2`）
+1. **Version Bump**: Use `bump_version.py` script
+2. **GitHub Actions**: Automatically build and publish to PyPI
+3. **Trigger Conditions**:
+   - Push to `main` branch
+   - Create `v*` tag (e.g., `v0.1.2`)
 
-### 🔧 版本文件同步
+### 🔧 Version File Synchronization
 
-脚本会自动更新以下文件中的版本：
+The script automatically updates versions in the following files:
 - `scalebox/__init__.py`
 - `scalebox/version.py`
 - `pyproject.toml`
-- `CHANGELOG.md`（可选）
+- `CHANGELOG.md` (optional)
 
-### 📋 发布步骤
+### 📋 Release Steps
 
 ```bash
-# 1. 升级版本
+# 1. Bump version
 python scripts/bump_version.py patch
 
-# 2. 检查更改
+# 2. Check changes
 git diff
 
-# 3. 提交更改
+# 3. Commit changes
 git add .
 git commit -m "Bump version to 0.1.2"
 
-# 4. 推送并创建标签
+# 4. Push and create tag
 git push origin main
 git push origin --tags
 
-# 5. GitHub Actions 会自动发布到 PyPI
+# 5. GitHub Actions will automatically publish to PyPI
 ```
 
-### 🏷️ 版本规则
+### 🏷️ Version Rules
 
-- **MAJOR**：不兼容的API更改
-- **MINOR**：向后兼容的功能添加
-- **PATCH**：向后兼容的错误修复
+- **MAJOR**: Incompatible API changes
+- **MINOR**: Backward-compatible feature additions
+- **PATCH**: Backward-compatible bug fixes
 
-## 常见问题（Troubleshooting）
-- Import/依赖错误：请确认已激活 venv 并正确安装 `scalebox/requirements.txt` 所需依赖
-- `ModuleNotFoundError`：在测试脚本中添加项目根路径到 `sys.path`，或从项目根目录运行
-- 外部内核不可用：确保环境已安装对应语言运行时（R/Node/Deno/JDK）与后端已启用该内核
-- 超时/网络：检查网络与后端服务可达性，必要时增大 `timeout`/`request_timeout`
+## Troubleshooting
+- **Import/dependency errors**: Ensure venv is activated and all required dependencies from `scalebox/requirements.txt` are installed
+- **`ModuleNotFoundError`**: Add the project root path to `sys.path` in test scripts, or run from the project root directory
+- **External kernels unavailable**: Ensure the environment has the corresponding language runtime installed (R/Node/Deno/JDK) and the backend has enabled that kernel
+- **Timeout/network issues**: Check network connectivity and backend service accessibility, increase `timeout`/`request_timeout` if necessary
 
-## 许可证
-本项目遵循项目仓库所附许可证（LICENSE）条款。
+## License
+This project is licensed under the terms of the LICENSE file in the repository.

{scalebox_sdk-0.1.14.dist-info → scalebox_sdk-0.1.15.dist-info}/RECORD

@@ -1,9 +1,9 @@
-scalebox/__init__.py,sha256=T8maPxMttoWt6YjoyyRcNDgXbHdKkaBnzc7D9Wq_-WM,1812
+scalebox/__init__.py,sha256=QG3xEv5Gg61_bZKmDsCEwEQmXKZQSkBcMkNs6so7JXk,1812
 scalebox/cli.py,sha256=HWIyGuhbP1WZm839CwTysauL78xMBOoatFychxzloxQ,3904
 scalebox/connection_config.py,sha256=J49-3tYaaoRDpa1l2dbnW3T8XmLrqEZBPXlraFvPp7I,2563
 scalebox/exceptions.py,sha256=10R9VXfvgO4XJJnxyzyrzkxliyeEBX0ZC36izXa8R5k,2053
 scalebox/requirements.txt,sha256=LEYsk2VzoxKR-V44Y6qJuJ3vKdTYS79f1Gv1Ajleifo,567
-scalebox/version.py,sha256=m1BKx1iToiCH8M-PikRYtzbwMMX3yEYCig65wk3Ccyo,323
+scalebox/version.py,sha256=4fBt8EdDgj_M68VIKu4UNlceTZXPlBfRYSzaU0_7d1k,323
 scalebox/api/__init__.py,sha256=_9nWyeNg4Y_Z30YpBNoDP6S92YdlO_5xBkrp-we0SIg,4167
 scalebox/api/metadata.py,sha256=lg5ekfnFZYZoCoJxIPo961HEGVg_rLLRJBbw4ZApM_Y,512
 scalebox/api/client/__init__.py,sha256=IVRaxvQcdPu1Xxc3t--g3ir3Wl5f3Y0zKMwy1nkKN80,155
@@ -79,7 +79,7 @@ scalebox/code_interpreter/models.py,sha256=so4_kPkouB9ET0MN2LkeTaPWXAXJNQIaz0IEY
 scalebox/csx_connect/__init__.py,sha256=LpNSDgIjJbOyeddLRyTVLsY0UqRWYAvlAn0itEDhuao,81
 scalebox/csx_connect/client.py,sha256=fmlND6h2iiTaeWcccf6aukvQ_6SCblr1RylArGN3k78,13151
 scalebox/csx_desktop/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scalebox/csx_desktop/main.py,sha256=dDjiQf0sGYO8HMIyOkDPEipd7F_7Sofijqug1G--l7U,21819
+scalebox/csx_desktop/main.py,sha256=mdnHFaAxreH6xgI1-vRuXEmNM9F3CPJxdmpfLOwhJEw,21908
 scalebox/generated/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scalebox/generated/api.py,sha256=SjK64GhgaWFMkktn4ekb5p8zBZXvA88GZ4legCT27Jo,1558
 scalebox/generated/api_pb2.py,sha256=n6SmPlDl4Fx6vQl3kiw6oXUb9eTLK07_WNHjoPOhtLI,25941
@@ -117,8 +117,8 @@ scalebox/sandbox_sync/commands/pty.py,sha256=KQStIe-ts_sSWjE_zD01AMqMCGbq9wGeXzb
 scalebox/sandbox_sync/filesystem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scalebox/sandbox_sync/filesystem/filesystem.py,sha256=ajZgv3VyBfFtO8o4BIx6w7z1vhFugnLXysRfLBsa_ms,18193
 scalebox/sandbox_sync/filesystem/watch_handle.py,sha256=dC9p74AHMv-3mQ1tudmOPjrpjvcJ7wFmCduNdity6os,2027
-scalebox/test/CODE_INTERPRETER_TESTS_READY.md,sha256=cU9aOccv6BWllsz4aIIHokMW9QPxsPlJEJKR_oXr69o,9695
-scalebox/test/README.md,sha256=YwFmc4kjgZN9uRVrN2qCPUDC6RfeAXFJ-syeRS9mdiE,8182
+scalebox/test/CODE_INTERPRETER_TESTS_READY.md,sha256=gtS9jRp2VB44MVG-ztb1JgYiqWtea8Z-TMEK1mZzfgE,11365
+scalebox/test/README.md,sha256=1rpgOo8uv-zT6QNw05MCCl8XzplD6xvWl3gE7frn9xI,9129
 scalebox/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scalebox/test/aclient.py,sha256=hCZAs2X1AwRHevexdbH0Z2MdahSczjvRglnyb1WFrV4,2335
 scalebox/test/code_interpreter_centext.py,sha256=f2GC3l8jsNF9n1Sl4boxJMGqWNl1d1Ff29f_5hahH00,468
@@ -148,9 +148,9 @@ scalebox/test/testsandbox_sync.py,sha256=v1dFAJWKbyLnjIiafTR9TafxJF1gaUk-W2mmQU4
 scalebox/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scalebox/utils/httpcoreclient.py,sha256=kjTndd-YECPe3n_G1HfGgitzRwntC21tqtIqZ62V6Lg,9868
 scalebox/utils/httpxclient.py,sha256=oLpCP2RChvnspS6Unl6ngmpY72yPokTfSqMm9m-7k38,13442
-scalebox_sdk-0.1.14.dist-info/licenses/LICENSE,sha256=9zP32kHlBovkfji1R6ptx3H7WjJJvnf4UuwTpfogmsY,1069
-scalebox_sdk-0.1.14.dist-info/METADATA,sha256=dH-vRHJljDCPF9nQnrMbrO3vkWuqN3StcEPYMafX70c,12198
-scalebox_sdk-0.1.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scalebox_sdk-0.1.14.dist-info/entry_points.txt,sha256=g7C1Trcg8EyvAGMnHpJ3alqtZzQuMypYUQVFK13kOFM,47
-scalebox_sdk-0.1.14.dist-info/top_level.txt,sha256=CDjlibkbOG-MT-s1TRxs4Xe_iN1m11ii48spB6DOMj4,9
-scalebox_sdk-0.1.14.dist-info/RECORD,,
+scalebox_sdk-0.1.15.dist-info/licenses/LICENSE,sha256=9zP32kHlBovkfji1R6ptx3H7WjJJvnf4UuwTpfogmsY,1069
+scalebox_sdk-0.1.15.dist-info/METADATA,sha256=1eO1vkpp8FL4ociKeIvDdGaFq-hZZxfrQ5bvyI0haQI,12736
+scalebox_sdk-0.1.15.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scalebox_sdk-0.1.15.dist-info/entry_points.txt,sha256=g7C1Trcg8EyvAGMnHpJ3alqtZzQuMypYUQVFK13kOFM,47
+scalebox_sdk-0.1.15.dist-info/top_level.txt,sha256=CDjlibkbOG-MT-s1TRxs4Xe_iN1m11ii48spB6DOMj4,9
+scalebox_sdk-0.1.15.dist-info/RECORD,,