Add snippet to readme #194

ArthurKamalov · 2025-12-01T16:53:16Z

This PR adds a snippet with an example of SDK usage in the README file.

k8s-ci-robot · 2025-12-01T16:53:22Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ArthurKamalov
Once this PR has been reviewed and has the lgtm label, please assign janetkuo for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot · 2025-12-01T16:53:24Z

Welcome @ArthurKamalov!

It looks like this is your first PR to kubernetes-sigs/agent-sandbox 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/agent-sandbox has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2025-12-01T16:53:25Z

Hi @ArthurKamalov. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

netlify · 2025-12-01T16:53:34Z

✅ Deploy Preview for agent-sandbox canceled.

Name	Link
🔨 Latest commit	`e05ae8f`
🔍 Latest deploy log	https://app.netlify.com/projects/agent-sandbox/deploys/692dc7fe007f810008ea45c5

janetkuo · 2025-12-02T01:27:02Z

/ok-to-test

barney-s

Thanks for adding this Python SDK example to the README. It's a great starting point for users. I have a few minor suggestions to make the snippet more robust and clearer, mostly around error handling and explaining the assumptions made in the example.

barney-s · 2025-12-02T21:37:12Z

README.md

+try:
+    with Sandbox(
+        template_name="python-runtime-template",
+        namespace="ai-agents"


Using a hardcoded namespace like ai-agents might cause the example to fail for users who don't have this namespace created or don't have permissions to access it. Consider adding a comment mentioning that this namespace must exist, or suggest a more common default like default.

barney-s · 2025-12-02T21:37:12Z

README.md

+        print(f"Read content: {content}")
+
+except Exception as e:
+    print(f"An error occurred: {e}")


Catching the generic Exception is a bit broad. If the SDK has its own exception types (e.g., for connection errors, sandbox creation failures), it would be better to catch those specifically. If not, a comment explaining that this is simplified for the example would be helpful.

barney-s · 2025-12-02T21:37:12Z

README.md

+        print(f"Stdout: {result.stdout.strip()}")
+
+        # 2. Write and read files
+        sandbox.write("test.txt", "This is a test file.")


The write() method appears to take a string, while the read() method returns bytes that need decoding. This asymmetry in the API could be confusing. It would be clearer if the example showed encoding the string before writing, e.g., sandbox.write("test.txt", "This is a test file.".encode('utf-8')), to make the process more explicit.

barney-s · 2025-12-02T21:37:13Z

README.md

+        print("--- Sandbox is Ready! ---")
+
+        # 1. Run a command inside the secure sandbox
+        result = sandbox.run("echo 'Hello from inside the sandbox!'")


The example doesn't check if the command executed successfully. The result object from sandbox.run() should be checked for an error or a non-zero exit code to ensure the command didn't fail silently. A robust example should include error handling for the execution result.

barney-s · 2025-12-02T21:37:13Z

README.md

+# The SDK abstracts all YAML into a simple context manager
+try:
+    with Sandbox(
+        template_name="python-runtime-template",


Similar to the namespace, the template_name is hardcoded. It would be beneficial to add a small note explaining that this template must be available on the cluster for the example to work.

barney-s · 2025-12-02T21:37:13Z

README.md

+For a more programatic approach you can use the [SDK](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/clients/python/agentic-sandbox-client/README.md) like the following:
+```python
+from agentic_sandbox import Sandbox
+


The link to the SDK points to the README on the main branch. This could become outdated. Consider linking to the directory /clients/python/agentic-sandbox-client/ instead, which is a more stable reference.

janetkuo · 2025-12-06T01:48:24Z

README.md

 This will create a new Sandbox named `my-sandbox` running the image you specify. You can then access the Sandbox using its stable hostname, `my-sandbox`.

-For more complex examples, including how to use the extensions, please see the [examples/](examples/) and [extensions/examples/](extensions/examples/) directories.
+For a more programatic approach you can use the [SDK](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/clients/python/agentic-sandbox-client/README.md) like the following:


We should use relative links so that it moves with git commits

janetkuo · 2025-12-06T01:51:09Z

README.md

 This will create a new Sandbox named `my-sandbox` running the image you specify. You can then access the Sandbox using its stable hostname, `my-sandbox`.

-For more complex examples, including how to use the extensions, please see the [examples/](examples/) and [extensions/examples/](extensions/examples/) directories.
+For a more programatic approach you can use the [SDK](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/clients/python/agentic-sandbox-client/README.md) like the following:


typo

Suggested change

For a more programatic approach you can use the [SDK](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/clients/python/agentic-sandbox-client/README.md) like the following:

For a more programmatic approach you can use the [SDK](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/clients/python/agentic-sandbox-client/README.md) like the following:

janetkuo · 2025-12-06T01:54:43Z

README.md

+        namespace="ai-agents"
+    ) as sandbox:
+
+        print("--- Sandbox is Ready! ---")


Can we remove these prints, as this makes the example more verbose than necessary, and the focus should be on showing the syntax.

volatilemolotov and others added 3 commits November 25, 2025 21:30

add snippet to readme

954d392

force https link

948ae41

make links to examples in readme refer to github

e05ae8f

k8s-ci-robot requested review from justinsb and soltysh December 1, 2025 16:53

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 1, 2025

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 2, 2025

barney-s reviewed Dec 2, 2025

View reviewed changes

janetkuo reviewed Dec 6, 2025

View reviewed changes

	For a more programatic approach you can use the [SDK](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/clients/python/agentic-sandbox-client/README.md) like the following:
	For a more programmatic approach you can use the [SDK](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/clients/python/agentic-sandbox-client/README.md) like the following:

Add snippet to readme #194

Are you sure you want to change the base?

Add snippet to readme #194

Conversation

ArthurKamalov commented Dec 1, 2025

Uh oh!

k8s-ci-robot commented Dec 1, 2025

Uh oh!

k8s-ci-robot commented Dec 1, 2025

Uh oh!

k8s-ci-robot commented Dec 1, 2025

Uh oh!

netlify bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for agent-sandbox canceled.

Uh oh!

janetkuo commented Dec 2, 2025

Uh oh!

barney-s left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

netlify bot commented Dec 1, 2025 •

edited

Loading