From a21272e1eccaf1ed9deece6aca42772033538678 Mon Sep 17 00:00:00 2001 From: "Dorian (BoxLite AI)" Date: Mon, 16 Mar 2026 08:08:34 +0000 Subject: [PATCH] docs: fix false claims about CodeBox auto-install and state persistence Fixes #233: Remove claim that CodeBox automatically installs packages. Packages must be installed explicitly via install_package(). Fixes #234: Add note clarifying that run() executes in fresh processes. Variables and state do not persist between run() calls. Co-Authored-By: Claude Opus 4.5 --- docs/getting-started/quickstart-python.md | 11 +++++++---- sdks/python/README.md | 3 ++- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/getting-started/quickstart-python.md b/docs/getting-started/quickstart-python.md index 8dd82ce7..efb42385 100644 --- a/docs/getting-started/quickstart-python.md +++ b/docs/getting-started/quickstart-python.md @@ -69,6 +69,8 @@ print(response.text) """ async with boxlite.CodeBox() as codebox: + # Install packages explicitly before use + await codebox.install_package("requests") result = await codebox.run(code) print(result) @@ -83,10 +85,11 @@ python codebox.py ``` **What's happening:** -1. CodeBox automatically installs required packages (requests) -2. Executes the code in complete isolation -3. Returns the output -4. Your host system remains completely safe +1. CodeBox executes the code in complete isolation +2. Returns the output +3. Your host system remains completely safe + +**Note:** Each `run()` call executes in a fresh Python process. Variables, imports, and state do not persist between calls. To share state, combine code into a single `run()` call. ## Running Examples diff --git a/sdks/python/README.md b/sdks/python/README.md index 2066af64..e0dab968 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -79,7 +79,8 @@ print(response.text) """ async with boxlite.CodeBox() as codebox: - # CodeBox automatically installs packages + # Install packages explicitly before use + await codebox.install_package("requests") result = await codebox.run(code) print(result)