docs: cover new praisonai-sandbox C13 standalone package#2102
docs: cover new praisonai-sandbox C13 standalone package#2102praisonai-triage-agent[bot] wants to merge 1 commit into
Conversation
|
@coderabbitai review |
|
/review |
|
@gemini review this PR |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
✅ Action performedReview finished.
|
MervinPraison
added
pipeline/awaiting-merge-gate
|
Important Review skippedBot user detected. To trigger a single review, invoke the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughChangesStandalone sandbox documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for the new standalone praisonai-sandbox package, which extracts sandbox backends (such as Docker, subprocess, Sandlock, SSH, Modal, and E2B) from the main praisonai wrapper to allow for a minimal footprint. The changes include adding new documentation pages, updating installation guides, and recommending the new praisonai_sandbox import path. The reviewer's feedback correctly identifies several instances where classes like SandboxConfig and ResourceLimits are imported from the internal praisonaiagents.sandbox submodule, recommending instead that they be imported directly from the main praisonaiagents package for consistency and simplicity.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| from praisonai_sandbox import DockerSandbox | ||
| from praisonaiagents.sandbox import SandboxConfig |
There was a problem hiding this comment.
For consistency and simplicity, it is recommended to import SandboxConfig directly from praisonaiagents rather than from the internal praisonaiagents.sandbox module. This aligns with the standard usage shown elsewhere in the documentation.
from praisonai_sandbox import DockerSandbox
from praisonaiagents import SandboxConfig
| from praisonai_sandbox import DockerSandbox | ||
| from praisonaiagents.sandbox import SandboxConfig |
There was a problem hiding this comment.
For consistency and simplicity, it is recommended to import SandboxConfig directly from praisonaiagents rather than from the internal praisonaiagents.sandbox module. This aligns with the standard usage shown elsewhere in the documentation.
from praisonai_sandbox import DockerSandbox
from praisonaiagents import SandboxConfig
| from praisonai_sandbox import DockerSandbox | ||
| from praisonaiagents.sandbox import SandboxConfig |
There was a problem hiding this comment.
For consistency and simplicity, it is recommended to import SandboxConfig directly from praisonaiagents rather than from the internal praisonaiagents.sandbox module. This aligns with the standard usage shown elsewhere in the documentation.
from praisonai_sandbox import DockerSandbox
from praisonaiagents import SandboxConfig
| from praisonaiagents.sandbox import ResourceLimits | ||
| # New (recommended); shim: from praisonai.sandbox import SubprocessSandbox | ||
| from praisonai_sandbox import SubprocessSandbox |
There was a problem hiding this comment.
For consistency and simplicity, it is recommended to import ResourceLimits directly from praisonaiagents rather than from the internal praisonaiagents.sandbox module. This aligns with the standard usage shown elsewhere in the documentation.
from praisonaiagents import ResourceLimits
# New (recommended); shim: from praisonai.sandbox import SubprocessSandbox
from praisonai_sandbox import SubprocessSandbox
|
Automated merge-conflict rebase started (in-band Claude). Rebasing onto latest |
MervinPraison
added
pipeline/blocked:conflict
56a747d to
339483a
Compare
Rebase completeBranch Files resolved
Verification
|
|
Automated merge-conflict rebase started (in-band Claude). Rebasing onto latest |
339483a to
a8c3bf9
Compare
Rebase completeRebased claude/issue-2101-20260717-0831 onto origin/main (65e913d). All conflicts resolved. Files resolved
Verification
|
MervinPraison
added
pipeline/blocked:ci
|
Automated merge-conflict rebase started (in-band Claude). Rebasing onto latest |
MervinPraison
added
pipeline/blocked:conflict
a8c3bf9 to
bc1b0ff
Compare
Rebase complete ✅Rebased Files resolved
Verification
|
MervinPraison
added
pipeline/blocked:ci
|
Automated merge-conflict rebase started (in-band Claude). Rebasing onto latest |
Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
bc1b0ff to
2a25981
Compare
Rebase complete ✅Resolved merge conflict on Files resolved:
Verification:
|
MervinPraison
added
pipeline/blocked:ci
1 participant
Fixes #2101
Summary
Documents the newly-extracted
praisonai-sandboxstandalone Tier-2 package (upstream PR MervinPraison/PraisonAI#3129), which moves the sandbox backends (Docker, subprocess, Sandlock, SSH, Modal, E2B, Daytona) out of thepraisonaiwrapper.New pages
docs/features/praisonai-sandbox-package.mdx— primary landing page: hero mermaid, agent-centric Quick Start (sandbox=True→SandboxConfig→ standalonepraisonai_sandboximports), install matrix, "do I need it directly?" decision mermaid,SandboxManagerflow, console-script note, backward-compat shims.docs/sdk/praisonai-sandbox/index.mdx— SDK overview: install matrix + public API surface.Updated pages
docs/features/sandbox.mdx—<Note>about the new package + "New import path" subsection; install/import lines now showpraisonai-sandbox[...]extras and thepraisonai_sandboxpath (shims kept and labeled). SSH updated fromparamiko→asyncssh.docs/features/sandbox-backends.mdx— install table gets a via standalone column; registry/backend imports point atpraisonai_sandboxwith shim notes; plugin discovery note; new Related card.docs/installation.mdx—praisonai-sandboxadded to transitive-install notes, decision + dependency mermaids, and a new card.docs/cli/sandbox.mdx— callout for the newpraisonai-sandboxconsole script (hint-only stub today).docs/features/sandboxed-agent.mdx— one-line note that execution now routes throughpraisonai_sandbox.docs.json— new Features + SDK entries.Verification
src/praisonai-sandbox/pyproject.toml,praisonai_sandbox/__init__.py, and__main__.py.from praisonai.sandbox import …is explicitly labeled as a backward-compat shim (except the auto-generated reference file, left untouched per AGENTS.md).docs.jsonvalidated withpython -m json.tool.🤖 Generated with Claude Code
Summary by CodeRabbit
praisonai-sandboxpackage, including installation options, supported backends, configuration, and usage examples.