openai-agents-prized 0.1.0__tar.gz

openai_agents_prized-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+.venv/
+dist/
+__pycache__/
+.pytest_cache/
+.ruff_cache/

openai_agents_prized-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

openai_agents_prized-0.1.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.5
+Name: openai-agents-prized
+Version: 0.1.0
+Summary: Prized Sandboxes (Linux microVMs) as a sandbox client for the OpenAI Agents SDK
+Project-URL: Homepage, https://prized.dev/docs/sandboxes
+Project-URL: Documentation, https://prized.dev/docs/sandboxes-openai-agents
+Project-URL: API reference, https://prized.dev/docs/sandboxes-api
+Author-email: Prized <team@prized.dev>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,firecracker,microvm,openai,openai-agents,prized,sandbox
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.10
+Requires-Dist: httpx<1.0.0,>=0.27.0
+Requires-Dist: openai-agents<0.26.0,>=0.23.1
+Description-Content-Type: text/markdown
+
+# openai-agents-prized
+
+[Prized Sandboxes](https://prized.dev/docs/sandboxes) as a sandbox client for the [OpenAI Agents SDK](https://openai.github.io/openai-agents-python/sandbox/clients/). A `SandboxAgent` runs its shell commands and file edits in a Prized sandbox, a Linux microVM that is deleted when the run ends.
+
+## Install
+
+```bash
+pip install openai-agents-prized
+export PRIZED_API_KEY=dcp_...
+export OPENAI_API_KEY=sk-...
+```
+
+Make the Prized key at [prized.dev/dashboard/workspace/api-keys](https://prized.dev/dashboard/workspace/api-keys) with **Full access**, or **Custom** with **Sandboxes: Write**. Python 3.10 or later, `openai-agents` 0.23.1 or later, below 0.26.
+
+## Run an agent
+
+```python
+import asyncio
+
+from agents import Runner
+from agents.run import RunConfig
+from agents.sandbox import SandboxAgent, SandboxRunConfig
+
+from openai_agents_prized import PrizedSandboxClient, PrizedSandboxClientOptions
+
+
+async def main() -> None:
+    agent = SandboxAgent(name="coder", instructions="Work in the sandbox with your tools.")
+    run_config = RunConfig(
+        sandbox=SandboxRunConfig(
+            client=PrizedSandboxClient(),
+            options=PrizedSandboxClientOptions(vcpu=2, memory_mb=4096),
+        )
+    )
+    result = await Runner.run(
+        agent, "Write fizzbuzz.py, run it for 15, and show me the output.", run_config=run_config
+    )
+    print(result.final_output)
+
+
+asyncio.run(main())
+```
+
+The agent's `exec_command`, `write_stdin`, and `apply_patch` tools run in the sandbox as the user `prized`, in `/home/prized/work`. A manifest on the SDK's default root (`/workspace`) is placed there too.
+
+## Options
+
+`PrizedSandboxClientOptions` maps to the Sandbox API's [create](https://prized.dev/docs/sandboxes-api#create):
+
+| Option | Default | Effect |
+| --- | --- | --- |
+| `template` | `prized-base-v1` | `prized-agent-v1` adds Claude Code and Codex |
+| `vcpu`, `memory_mb`, `disk_gb` | The template's | The sandbox's shape |
+| `env_vars`, `labels` | None | Set for every command; yours to filter on |
+| `auto_pause_min`, `auto_delete_min`, `max_runtime_min` | Off, off, 1,440 (60 on the free tier) | Automatic pause and delete |
+| `pause_on_exit` | `False` | Pause instead of delete at the end of a run, so `resume()` continues in the same sandbox with its files and installs (the SDK ends the run's commands before the pause) |
+| `timeouts` | | `PrizedSandboxTimeouts`: per-command default, startup, and archive timeouts |
+
+`PrizedSandboxClient(api_key=..., api_url=...)` reads `PRIZED_API_KEY` and `PRIZED_API_URL` when they are not passed.
+
+## Pause and resume
+
+The client implements the SDK's session lifecycle: `RunState` round trips, snapshots, and `resume()`. With `pause_on_exit=True`, a paused sandbox keeps memory and disk for the price of storage, and the resumed run reuses it without restoring anything. Without it, the sandbox is deleted and a resumed run starts a new one and restores the workspace from the session's snapshot.
+
+## Moving from Runloop
+
+`openai-agents` removed `RunloopSandboxClient`. Swap the client and options; the agent stays the same:
+
+| Runloop | Prized |
+| --- | --- |
+| `RunloopSandboxClient()` | `PrizedSandboxClient()` |
+| `RunloopSandboxClientOptions(blueprint_name=...)` | `PrizedSandboxClientOptions(template=...)` |
+| `env_vars`, `pause_on_exit` | Same names |
+| `metadata` | `labels` |
+| `exposed_ports`, tunnels, gateways, MCP, managed secrets, mounts | Not supported |
+
+Runloop session state cannot be resumed on Prized; start new runs.
+
+## Limits
+
+- **No root.** Commands run as `prized` without sudo, so manifest users other than `prized`, manifest groups, and mounts are refused before a sandbox is created.
+- **No inbound network.** Sandboxes reach the internet, but nothing reaches them: no exposed ports.
+- **Commands.** A command that outlives `exec_command`'s yield keeps running, and `write_stdin` polls it or types into it (with `tty=True`, Ctrl-C included). It runs until it exits or the session ends, unless the tool call passes a `timeout`. A command run with `exec` takes up to an hour (`PrizedSandboxTimeouts.exec_timeout_unbounded_s`) and keeps the first 4 MiB of its output and of its errors.
+- **Snapshots.** Symlinks are kept as links, so a virtualenv in the workspace comes back working in a replacement sandbox; hard-linked files come back as separate copies.
+- **Run time.** 24 hours of running by default, up to 7 days with `max_runtime_min`; on the free tier 60 minutes, 2 vCPU and 4 GB.
+- **Keys.** Code in the sandbox, the model's included, can read `env_vars`. Keep your Prized key out of them.
+
+Refusals from the API raise `PrizedAPIError` with the API's [error code](https://prized.dev/docs/sandboxes-api#errors); sandbox failures inside a run surface as the SDK's own `SandboxError` types.
+
+## When something fails
+
+A failed or cancelled create deletes the sandbox it made, and a failed resume pauses the sandbox it woke; if even that cannot reach the API, a warning names the sandbox. An answer that never came is settled by reading the sandbox, so a pause that landed is never followed by a delete. `close()` waits for cleanup a cancellation left running. A command whose answer is lost is never sent again, and its error says which of three it was: it never reached the sandbox, it may or may not have run, or it ran but the answer could not be read.
+
+## Development
+
+```bash
+uv sync
+uv run pytest                                          # offline, against an in-process fake of the API
+PRIZED_LIVE_TESTS=1 PRIZED_API_KEY=dcp_... uv run pytest -m live   # the SDK's lifecycle test on real sandboxes
+PRIZED_API_KEY=dcp_... uv run python scripts/live_agent.py         # a coding agent end to end, scripted model turns
+```
+
+Apache-2.0.

openai_agents_prized-0.1.0/README.md

@@ -0,0 +1,103 @@
+# openai-agents-prized
+
+[Prized Sandboxes](https://prized.dev/docs/sandboxes) as a sandbox client for the [OpenAI Agents SDK](https://openai.github.io/openai-agents-python/sandbox/clients/). A `SandboxAgent` runs its shell commands and file edits in a Prized sandbox, a Linux microVM that is deleted when the run ends.
+
+## Install
+
+```bash
+pip install openai-agents-prized
+export PRIZED_API_KEY=dcp_...
+export OPENAI_API_KEY=sk-...
+```
+
+Make the Prized key at [prized.dev/dashboard/workspace/api-keys](https://prized.dev/dashboard/workspace/api-keys) with **Full access**, or **Custom** with **Sandboxes: Write**. Python 3.10 or later, `openai-agents` 0.23.1 or later, below 0.26.
+
+## Run an agent
+
+```python
+import asyncio
+
+from agents import Runner
+from agents.run import RunConfig
+from agents.sandbox import SandboxAgent, SandboxRunConfig
+
+from openai_agents_prized import PrizedSandboxClient, PrizedSandboxClientOptions
+
+
+async def main() -> None:
+    agent = SandboxAgent(name="coder", instructions="Work in the sandbox with your tools.")
+    run_config = RunConfig(
+        sandbox=SandboxRunConfig(
+            client=PrizedSandboxClient(),
+            options=PrizedSandboxClientOptions(vcpu=2, memory_mb=4096),
+        )
+    )
+    result = await Runner.run(
+        agent, "Write fizzbuzz.py, run it for 15, and show me the output.", run_config=run_config
+    )
+    print(result.final_output)
+
+
+asyncio.run(main())
+```
+
+The agent's `exec_command`, `write_stdin`, and `apply_patch` tools run in the sandbox as the user `prized`, in `/home/prized/work`. A manifest on the SDK's default root (`/workspace`) is placed there too.
+
+## Options
+
+`PrizedSandboxClientOptions` maps to the Sandbox API's [create](https://prized.dev/docs/sandboxes-api#create):
+
+| Option | Default | Effect |
+| --- | --- | --- |
+| `template` | `prized-base-v1` | `prized-agent-v1` adds Claude Code and Codex |
+| `vcpu`, `memory_mb`, `disk_gb` | The template's | The sandbox's shape |
+| `env_vars`, `labels` | None | Set for every command; yours to filter on |
+| `auto_pause_min`, `auto_delete_min`, `max_runtime_min` | Off, off, 1,440 (60 on the free tier) | Automatic pause and delete |
+| `pause_on_exit` | `False` | Pause instead of delete at the end of a run, so `resume()` continues in the same sandbox with its files and installs (the SDK ends the run's commands before the pause) |
+| `timeouts` | | `PrizedSandboxTimeouts`: per-command default, startup, and archive timeouts |
+
+`PrizedSandboxClient(api_key=..., api_url=...)` reads `PRIZED_API_KEY` and `PRIZED_API_URL` when they are not passed.
+
+## Pause and resume
+
+The client implements the SDK's session lifecycle: `RunState` round trips, snapshots, and `resume()`. With `pause_on_exit=True`, a paused sandbox keeps memory and disk for the price of storage, and the resumed run reuses it without restoring anything. Without it, the sandbox is deleted and a resumed run starts a new one and restores the workspace from the session's snapshot.
+
+## Moving from Runloop
+
+`openai-agents` removed `RunloopSandboxClient`. Swap the client and options; the agent stays the same:
+
+| Runloop | Prized |
+| --- | --- |
+| `RunloopSandboxClient()` | `PrizedSandboxClient()` |
+| `RunloopSandboxClientOptions(blueprint_name=...)` | `PrizedSandboxClientOptions(template=...)` |
+| `env_vars`, `pause_on_exit` | Same names |
+| `metadata` | `labels` |
+| `exposed_ports`, tunnels, gateways, MCP, managed secrets, mounts | Not supported |
+
+Runloop session state cannot be resumed on Prized; start new runs.
+
+## Limits
+
+- **No root.** Commands run as `prized` without sudo, so manifest users other than `prized`, manifest groups, and mounts are refused before a sandbox is created.
+- **No inbound network.** Sandboxes reach the internet, but nothing reaches them: no exposed ports.
+- **Commands.** A command that outlives `exec_command`'s yield keeps running, and `write_stdin` polls it or types into it (with `tty=True`, Ctrl-C included). It runs until it exits or the session ends, unless the tool call passes a `timeout`. A command run with `exec` takes up to an hour (`PrizedSandboxTimeouts.exec_timeout_unbounded_s`) and keeps the first 4 MiB of its output and of its errors.
+- **Snapshots.** Symlinks are kept as links, so a virtualenv in the workspace comes back working in a replacement sandbox; hard-linked files come back as separate copies.
+- **Run time.** 24 hours of running by default, up to 7 days with `max_runtime_min`; on the free tier 60 minutes, 2 vCPU and 4 GB.
+- **Keys.** Code in the sandbox, the model's included, can read `env_vars`. Keep your Prized key out of them.
+
+Refusals from the API raise `PrizedAPIError` with the API's [error code](https://prized.dev/docs/sandboxes-api#errors); sandbox failures inside a run surface as the SDK's own `SandboxError` types.
+
+## When something fails
+
+A failed or cancelled create deletes the sandbox it made, and a failed resume pauses the sandbox it woke; if even that cannot reach the API, a warning names the sandbox. An answer that never came is settled by reading the sandbox, so a pause that landed is never followed by a delete. `close()` waits for cleanup a cancellation left running. A command whose answer is lost is never sent again, and its error says which of three it was: it never reached the sandbox, it may or may not have run, or it ran but the answer could not be read.
+
+## Development
+
+```bash
+uv sync
+uv run pytest                                          # offline, against an in-process fake of the API
+PRIZED_LIVE_TESTS=1 PRIZED_API_KEY=dcp_... uv run pytest -m live   # the SDK's lifecycle test on real sandboxes
+PRIZED_API_KEY=dcp_... uv run python scripts/live_agent.py         # a coding agent end to end, scripted model turns
+```
+
+Apache-2.0.

openai_agents_prized-0.1.0/openai_agents_prized/__init__.py

@@ -0,0 +1,39 @@
+"""Prized Sandboxes for the OpenAI Agents SDK.
+
+```python
+from agents import Runner
+from agents.run import RunConfig
+from agents.sandbox import SandboxAgent, SandboxRunConfig
+from openai_agents_prized import PrizedSandboxClient
+
+agent = SandboxAgent(name="coder", instructions="Work in the sandbox.")
+run_config = RunConfig(sandbox=SandboxRunConfig(client=PrizedSandboxClient()))
+result = await Runner.run(agent, "Write fizzbuzz.py and run it.", run_config=run_config)
+```
+"""
+
+from openai_agents_prized._api import PrizedAPIError, PrizedError, PrizedSandboxGoneError
+from openai_agents_prized._version import __version__
+from openai_agents_prized.sandbox import (
+    DEFAULT_PRIZED_TEMPLATE,
+    DEFAULT_PRIZED_WORKSPACE_ROOT,
+    PrizedSandboxClient,
+    PrizedSandboxClientOptions,
+    PrizedSandboxSession,
+    PrizedSandboxSessionState,
+    PrizedSandboxTimeouts,
+)
+
+__all__ = [
+    "DEFAULT_PRIZED_TEMPLATE",
+    "DEFAULT_PRIZED_WORKSPACE_ROOT",
+    "PrizedAPIError",
+    "PrizedError",
+    "PrizedSandboxClient",
+    "PrizedSandboxClientOptions",
+    "PrizedSandboxGoneError",
+    "PrizedSandboxSession",
+    "PrizedSandboxSessionState",
+    "PrizedSandboxTimeouts",
+    "__version__",
+]