openai-agents 0.0.1__tar.gz → 0.0.2__tar.gz

openai_agents-0.0.2/.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Deploy docs
+
+on:
+  workflow_run:
+    workflows: ["Tests"]
+    types:
+      - completed
+
+permissions:
+  contents: write # This allows pushing to gh-pages
+
+jobs:
+  deploy_docs:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make sync
+      - name: Deploy docs
+        run: make deploy-docs

openai_agents-0.0.2/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types:
+      - published
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    environment:
+      name: pypi
+      url: https://pypi.org/p/openai-agents
+    permissions:
+      id-token: write # Important for trusted publishing to PyPI
+    runs-on: ubuntu-latest
+    env:
+      OPENAI_API_KEY: fake-for-tests
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make sync
+      - name: Build package
+        run: uv build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

openai_agents-0.0.2/.github/workflows/tests.yml

@@ -0,0 +1,86 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make sync
+      - name: Run lint
+        run: make lint
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make sync
+      - name: Run typecheck
+        run: make mypy
+
+  tests:
+    runs-on: ubuntu-latest
+    env:
+      OPENAI_API_KEY: fake-for-tests
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make sync
+      - name: Run tests
+        run: make tests
+
+  build-docs:
+    runs-on: ubuntu-latest
+    env:
+      OPENAI_API_KEY: fake-for-tests
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make sync
+      - name: Build docs
+        run: make build-docs
+
+  old_versions:
+    runs-on: ubuntu-latest
+    env:
+      OPENAI_API_KEY: fake-for-tests
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make sync
+      - name: Run tests
+        run: make old_version_tests

openai_agents-0.0.2/.prettierrc

@@ -0,0 +1,11 @@
+{
+    "tabWidth": 4,
+    "overrides": [
+        {
+            "files": "*.yml",
+            "options": {
+                "tabWidth": 2
+            }
+        }
+    ]
+}

openai_agents-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 OpenAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openai_agents-0.0.2/Makefile

@@ -0,0 +1,37 @@
+.PHONY: sync
+sync:
+	uv sync --all-extras --all-packages --group dev
+
+.PHONY: format
+format: 
+	uv run ruff format
+
+.PHONY: lint
+lint: 
+	uv run ruff check
+
+.PHONY: mypy
+mypy: 
+	uv run mypy .
+
+.PHONY: tests
+tests: 
+	uv run pytest 
+
+.PHONY: old_version_tests
+old_version_tests: 
+	UV_PROJECT_ENVIRONMENT=.venv_39 uv run --python 3.9 -m pytest
+	UV_PROJECT_ENVIRONMENT=.venv_39 uv run --python 3.9 -m mypy .
+
+.PHONY: build-docs
+build-docs:
+	uv run mkdocs build
+
+.PHONY: serve-docs
+serve-docs:
+	uv run mkdocs serve
+
+.PHONY: deploy-docs
+deploy-docs:
+	uv run mkdocs gh-deploy --force --verbose
+	

openai_agents-0.0.2/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: openai-agents
+Version: 0.0.2
+Summary: OpenAI Agents SDK
+Project-URL: Homepage, https://github.com/openai/openai-agents-python
+Project-URL: Repository, https://github.com/openai/openai-agents-python
+Author-email: OpenAI <support@openai.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: griffe<2,>=1.5.6
+Requires-Dist: openai>=1.66.0
+Requires-Dist: pydantic<3,>=2.10
+Requires-Dist: requests<3,>=2.0
+Requires-Dist: types-requests<3,>=2.0
+Requires-Dist: typing-extensions<5,>=4.12.2
+Description-Content-Type: text/markdown
+
+# OpenAI Agents SDK
+
+The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.
+
+<img src="docs/assets/images/orchestration.png" alt="Image of the Agents Tracing UI" style="max-height: 803px;">
+
+### Core concepts:
+
+1. [**Agents**](docs/agents.md): LLMs configured with instructions, tools, guardrails, and handoffs
+2. [**Handoffs**](docs/handoffs.md): Allow agents to transfer control to other agents for specific tasks
+3. [**Guardrails**](docs/guardrails.md): Configurable safety checks for input and output validation
+4. [**Tracing**](docs/tracing.md): Built-in tracking of agent runs, allowing you to view, debug and optimize your workflows
+
+Explore the [examples](examples) directory to see the SDK in action.
+
+## Get started
+
+1. Set up your Python environment
+
+```
+python -m venv env
+source env/bin/activate
+```
+
+2. Install Agents SDK
+
+```
+pip install openai-agents
+```
+
+## Hello world example
+
+```python
+from agents import Agent, Runner
+
+agent = Agent(name="Assistant", instructions="You are a helpful assistant")
+
+result = Runner.run_sync(agent, "Write a haiku about recursion in programming.")
+print(result.final_output)
+
+# Code within the code,
+# Functions calling themselves,
+# Infinite loop's dance.
+```
+
+(_If running this, ensure you set the `OPENAI_API_KEY` environment variable_)
+
+## Handoffs example
+
+```py
+from agents import Agent, Runner
+import asyncio
+
+spanish_agent = Agent(
+    name="Spanish agent",
+    instructions="You only speak Spanish.",
+)
+
+english_agent = Agent(
+    name="English agent",
+    instructions="You only speak English",
+)
+
+triage_agent = Agent(
+    name="Triage agent",
+    instructions="Handoff to the appropriate agent based on the language of the request.",
+    handoffs=[spanish_agent, english_agent],
+)
+
+
+async def main():
+    result = await Runner.run(triage_agent, input="Hola, ¿cómo estás?")
+    print(result.final_output)
+    # ¡Hola! Estoy bien, gracias por preguntar. ¿Y tú, cómo estás?
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Functions example
+
+```python
+import asyncio
+
+from agents import Agent, Runner, function_tool
+
+
+@function_tool
+def get_weather(city: str) -> str:
+    return f"The weather in {city} is sunny."
+
+
+agent = Agent(
+    name="Hello world",
+    instructions="You are a helpful agent.",
+    tools=[get_weather],
+)
+
+
+async def main():
+    result = await Runner.run(agent, input="What's the weather in Tokyo?")
+    print(result.final_output)
+    # The weather in Tokyo is sunny.
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## The agent loop
+
+When you call `Runner.run()`, we run a loop until we get a final output.
+
+1. We call the LLM, using the model and settings on the agent, and the message history.
+2. The LLM returns a response, which may include tool calls.
+3. If the response has a final output (see below for the more on this), we return it and end the loop.
+4. If the response has a handoff, we set the agent to the new agent and go back to step 1.
+5. We process the tool calls (if any) and append the tool responses messsages. Then we go to step 1.
+
+There is a `max_turns` parameter that you can use to limit the number of times the loop executes.
+
+### Final output
+
+Final output is the last thing the agent produces in the loop.
+
+1.  If you set an `output_type` on the agent, the final output is when the LLM returns something of that type. We use [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) for this.
+2.  If there's no `output_type` (i.e. plain text responses), then the first LLM response without any tool calls or handoffs is considered as the final output.
+
+As a result, the mental model for the agent loop is:
+
+1. If the current agent has an `output_type`, the loop runs until the agent produces structured output matching that type.
+2. If the current agent does not have an `output_type`, the loop runs until the current agent produces a message without any tool calls/handoffs.
+
+## Common agent patterns
+
+The Agents SDK is designed to be highly flexible, allowing you to model a wide range of LLM workflows including deterministic flows, iterative loops, and more. See examples in [`examples/agent_patterns`](examples/agent_patterns).
+
+## Tracing
+
+The Agents SDK includes built-in tracing, making it easy to track and debug the behavior of your agents. Tracing is extensible by design, supporting custom spans and a wide variety of external destinations, including [Logfire](https://logfire.pydantic.dev/docs/integrations/llms/openai/#openai-agents), [AgentOps](https://docs.agentops.ai/v1/integrations/agentssdk), and [Braintrust](https://braintrust.dev/docs/guides/traces/integrations#openai-agents-sdk). See [Tracing](http://openai.github.io/openai-agents-python/tracing.md) for more details.
+
+## Development (only needed if you need to edit the SDK/examples)
+
+0. Ensure you have [`uv`](https://docs.astral.sh/uv/) installed.
+
+```bash
+uv --version
+```
+
+1. Install dependencies
+
+```bash
+make sync
+```
+
+2. (After making changes) lint/test
+
+```
+make tests  # run tests
+make mypy   # run typechecker
+make lint   # run linter
+```
+
+## Acknowledgements
+
+We'd like to acknowledge the excellent work of the open-source community, especially:
+
+-   [Pydantic](https://docs.pydantic.dev/latest/) (data validation) and [PydanticAI](https://ai.pydantic.dev/) (advanced agent framework)
+-   [MkDocs](https://github.com/squidfunk/mkdocs-material)
+-   [Griffe](https://github.com/mkdocstrings/griffe)
+-   [uv](https://github.com/astral-sh/uv) and [ruff](https://github.com/astral-sh/ruff)
+
+We're committed to continuing to build the Agents SDK as an open source framework so others in the community can expand on our approach.

openai_agents-0.0.2/README.md

@@ -0,0 +1,174 @@
+# OpenAI Agents SDK
+
+The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.
+
+<img src="docs/assets/images/orchestration.png" alt="Image of the Agents Tracing UI" style="max-height: 803px;">
+
+### Core concepts:
+
+1. [**Agents**](docs/agents.md): LLMs configured with instructions, tools, guardrails, and handoffs
+2. [**Handoffs**](docs/handoffs.md): Allow agents to transfer control to other agents for specific tasks
+3. [**Guardrails**](docs/guardrails.md): Configurable safety checks for input and output validation
+4. [**Tracing**](docs/tracing.md): Built-in tracking of agent runs, allowing you to view, debug and optimize your workflows
+
+Explore the [examples](examples) directory to see the SDK in action.
+
+## Get started
+
+1. Set up your Python environment
+
+```
+python -m venv env
+source env/bin/activate
+```
+
+2. Install Agents SDK
+
+```
+pip install openai-agents
+```
+
+## Hello world example
+
+```python
+from agents import Agent, Runner
+
+agent = Agent(name="Assistant", instructions="You are a helpful assistant")
+
+result = Runner.run_sync(agent, "Write a haiku about recursion in programming.")
+print(result.final_output)
+
+# Code within the code,
+# Functions calling themselves,
+# Infinite loop's dance.
+```
+
+(_If running this, ensure you set the `OPENAI_API_KEY` environment variable_)
+
+## Handoffs example
+
+```py
+from agents import Agent, Runner
+import asyncio
+
+spanish_agent = Agent(
+    name="Spanish agent",
+    instructions="You only speak Spanish.",
+)
+
+english_agent = Agent(
+    name="English agent",
+    instructions="You only speak English",
+)
+
+triage_agent = Agent(
+    name="Triage agent",
+    instructions="Handoff to the appropriate agent based on the language of the request.",
+    handoffs=[spanish_agent, english_agent],
+)
+
+
+async def main():
+    result = await Runner.run(triage_agent, input="Hola, ¿cómo estás?")
+    print(result.final_output)
+    # ¡Hola! Estoy bien, gracias por preguntar. ¿Y tú, cómo estás?
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Functions example
+
+```python
+import asyncio
+
+from agents import Agent, Runner, function_tool
+
+
+@function_tool
+def get_weather(city: str) -> str:
+    return f"The weather in {city} is sunny."
+
+
+agent = Agent(
+    name="Hello world",
+    instructions="You are a helpful agent.",
+    tools=[get_weather],
+)
+
+
+async def main():
+    result = await Runner.run(agent, input="What's the weather in Tokyo?")
+    print(result.final_output)
+    # The weather in Tokyo is sunny.
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## The agent loop
+
+When you call `Runner.run()`, we run a loop until we get a final output.
+
+1. We call the LLM, using the model and settings on the agent, and the message history.
+2. The LLM returns a response, which may include tool calls.
+3. If the response has a final output (see below for the more on this), we return it and end the loop.
+4. If the response has a handoff, we set the agent to the new agent and go back to step 1.
+5. We process the tool calls (if any) and append the tool responses messsages. Then we go to step 1.
+
+There is a `max_turns` parameter that you can use to limit the number of times the loop executes.
+
+### Final output
+
+Final output is the last thing the agent produces in the loop.
+
+1.  If you set an `output_type` on the agent, the final output is when the LLM returns something of that type. We use [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) for this.
+2.  If there's no `output_type` (i.e. plain text responses), then the first LLM response without any tool calls or handoffs is considered as the final output.
+
+As a result, the mental model for the agent loop is:
+
+1. If the current agent has an `output_type`, the loop runs until the agent produces structured output matching that type.
+2. If the current agent does not have an `output_type`, the loop runs until the current agent produces a message without any tool calls/handoffs.
+
+## Common agent patterns
+
+The Agents SDK is designed to be highly flexible, allowing you to model a wide range of LLM workflows including deterministic flows, iterative loops, and more. See examples in [`examples/agent_patterns`](examples/agent_patterns).
+
+## Tracing
+
+The Agents SDK includes built-in tracing, making it easy to track and debug the behavior of your agents. Tracing is extensible by design, supporting custom spans and a wide variety of external destinations, including [Logfire](https://logfire.pydantic.dev/docs/integrations/llms/openai/#openai-agents), [AgentOps](https://docs.agentops.ai/v1/integrations/agentssdk), and [Braintrust](https://braintrust.dev/docs/guides/traces/integrations#openai-agents-sdk). See [Tracing](http://openai.github.io/openai-agents-python/tracing.md) for more details.
+
+## Development (only needed if you need to edit the SDK/examples)
+
+0. Ensure you have [`uv`](https://docs.astral.sh/uv/) installed.
+
+```bash
+uv --version
+```
+
+1. Install dependencies
+
+```bash
+make sync
+```
+
+2. (After making changes) lint/test
+
+```
+make tests  # run tests
+make mypy   # run typechecker
+make lint   # run linter
+```
+
+## Acknowledgements
+
+We'd like to acknowledge the excellent work of the open-source community, especially:
+
+-   [Pydantic](https://docs.pydantic.dev/latest/) (data validation) and [PydanticAI](https://ai.pydantic.dev/) (advanced agent framework)
+-   [MkDocs](https://github.com/squidfunk/mkdocs-material)
+-   [Griffe](https://github.com/mkdocstrings/griffe)
+-   [uv](https://github.com/astral-sh/uv) and [ruff](https://github.com/astral-sh/ruff)
+
+We're committed to continuing to build the Agents SDK as an open source framework so others in the community can expand on our approach.