Repository navigation
docs: clarify README purpose and getting started - #149
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Lead with Python use cases, installation and one interpreter example with deletion in finally. Explain Sandbox, AsyncSandbox, code_interpreter and ProviderSandbox in a small selection table. Link provider/template, server, authentication and migration guides. Keep client/server package ownership visible without namespace implementation details.
Requested as a review and improvement of all eight repository READMEs. This PR covers only python-sdk. Migration and maintenance details remain available through their owning guides. No runtime code or public API changes.
Type of Change
Changes
Testing
bash scripts/check-repo-health.sh: PASS: 106 checks, 0 failures; 1 warning.make hygiene: PASS.make test: PARTIAL: server suite 872 passed, 1 skipped, 3 failed; make stopped before client suite.pytest (three failed server tests after installing missing pip in the test environment): PARTIAL: package-list test now passes; malformed WebSocket and chunked-request tests still receive HTTP 501/502 instead of 400.pytest tests/ (client-sdk): PASS: 2348 passed, 27 skipped.make lint typecheck: PASS: Ruff checks passed for both packages; mypy passed for 56 server and 101 client source files (one unused-section configuration note).Checklist
Definition of Done
Documentation-only scope. Existing cloud/model acceptance receipts are preserved; no new runtime, model, cloud deployment or package-release claim is made. Runtime/template-specific checklist items are not applicable. Required latest-head CI and review gates remain in effect.
Local server follow-up: after installing missing pip in the isolated test environment, the package-list case passes. Two malformed raw-HTTP cases still return 501/502 rather than 400; their reason is not established and source is unchanged. The full latest-head remote matrix remains a merge gate.