pai-agent-sdk 0.4.1__tar.gz

pai_agent_sdk-0.4.1/.env.example

@@ -0,0 +1,64 @@
+# pai-agent-sdk Environment Variables
+# Copy this file to .env and uncomment the variables you need
+
+# =============================================================================
+# Web Search API Keys
+# =============================================================================
+
+# Google Custom Search API
+# Get your key at: https://developers.google.com/custom-search/v1/introduction
+# GOOGLE_SEARCH_API_KEY=your_google_search_api_key
+# GOOGLE_SEARCH_CX=your_google_search_cx
+
+# Tavily Search API
+# Get your key at: https://tavily.com/
+# TAVILY_API_KEY=your_tavily_api_key
+
+# =============================================================================
+# Image Search API Keys
+# =============================================================================
+
+# Pixabay API (stock images)
+# Get your key at: https://pixabay.com/api/docs/
+# PIXABAY_API_KEY=your_pixabay_api_key
+
+# RapidAPI (real-time image search)
+# Get your key at: https://rapidapi.com/
+# RAPIDAPI_API_KEY=your_rapidapi_key
+
+# =============================================================================
+# Web Scraping API Keys
+# =============================================================================
+
+# Firecrawl API
+# Get your key at: https://firecrawl.dev/
+# FIRECRAWL_API_KEY=your_firecrawl_api_key
+
+# =============================================================================
+# Agent Configuration (PAI_AGENT_ prefix)
+# =============================================================================
+
+# Model for image understanding when native vision is unavailable
+# PAI_AGENT_IMAGE_UNDERSTANDING_MODEL=gpt-4o-mini
+
+# Model for video understanding when native capability is unavailable
+# PAI_AGENT_VIDEO_UNDERSTANDING_MODEL=gemini-2.0-flash
+
+# Model for compact when native capability is unavailable
+# PAI_AGENT_COMPACT_MODEL=gemini-2.0-flash
+
+# =============================================================================
+# Browser Use Configuration (PAI_AGENT_BROWSER_USE_ prefix)
+# =============================================================================
+
+# Maximum retry attempts for tool calls
+# PAI_AGENT_BROWSER_USE_MAX_RETRIES=3
+
+# Tool name prefix
+# PAI_AGENT_BROWSER_USE_PREFIX=browser_use_
+
+# Force create new page instead of reusing existing
+# PAI_AGENT_BROWSER_USE_ALWAYS_USE_NEW_PAGE=false
+
+# Automatically close created page targets on context exit
+# PAI_AGENT_BROWSER_USE_AUTO_CLEANUP_PAGE=false

pai_agent_sdk-0.4.1/.gitattributes

@@ -0,0 +1,3 @@
+*.ipynb linguist-vendored
+*.js linguist-vendored
+*.csv linguist-vendored

pai_agent_sdk-0.4.1/.github/actions/setup-python-env/action.yml

@@ -0,0 +1,40 @@
+name: "Setup Python Environment"
+description: "Set up Python environment for the given Python version"
+
+inputs:
+  python-version:
+    description: "Python version to use"
+    required: true
+    default: "3.13"
+  uv-version:
+    description: "uv version to use"
+    required: true
+    default: "0.6.2"
+  extras:
+    description: "Optional extras to install (comma-separated, e.g., 'docker')"
+    required: false
+    default: ""
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: ${{ inputs.uv-version }}
+        enable-cache: 'true'
+        cache-suffix: ${{ matrix.python-version }}
+
+    - name: Install Python dependencies (no extras)
+      if: ${{ inputs.extras == '' }}
+      run: uv sync --frozen --python=${{ matrix.python-version }}
+      shell: bash
+
+    - name: Install Python dependencies (with extras)
+      if: ${{ inputs.extras != '' }}
+      run: uv sync --frozen --python=${{ matrix.python-version }} --extra ${{ inputs.extras }}
+      shell: bash

pai_agent_sdk-0.4.1/.github/workflows/main.yml

@@ -0,0 +1,71 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-python-env
+
+      - name: Run checks
+        run: make check
+
+  tests-and-type-check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # No extra only runs on 3.13
+        include:
+          - python-version: "3.11"
+            extras: "all"
+          - python-version: "3.12"
+            extras: "all"
+          - python-version: "3.13"
+            extras: "all"
+          # - python-version: "3.14"
+          #   extras: "all"
+          - python-version: "3.13"
+            extras: ""
+      fail-fast: false
+    env:
+      UV_PYTHON: ${{ matrix.python-version }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-python-env
+        with:
+          python-version: ${{ matrix.python-version }}
+          extras: ${{ matrix.extras }}
+
+      - name: Run tests
+        run: uv run python -m pytest tests -n auto --cov --cov-config=pyproject.toml --cov-report=xml
+
+      - name: Check typing
+        run: uv run pyright
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: youware-labs/pai-agent-sdk
+        if: ${{ matrix.python-version == '3.13' && matrix.extras == 'all' }}

pai_agent_sdk-0.4.1/.github/workflows/on-release-main.yml

@@ -0,0 +1,81 @@
+name: release-main
+
+permissions:
+  contents: write
+  packages: write
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  set-version:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Export tag
+        id: vars
+        run: echo tag=${GITHUB_REF#refs/*/} >> $GITHUB_OUTPUT
+        if: ${{ github.event_name == 'release' }}
+
+      - name: Update project version
+        run: |
+          sed -i "s/^version = \".*\"/version = \"$RELEASE_VERSION\"/" pyproject.toml
+        env:
+          RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
+        if: ${{ github.event_name == 'release' }}
+
+      - name: Upload updated pyproject.toml
+        uses: actions/upload-artifact@v4
+        with:
+          name: pyproject-toml
+          path: pyproject.toml
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: [set-version]
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Set up the environment
+        uses: ./.github/actions/setup-python-env
+
+      - name: Download updated pyproject.toml
+        uses: actions/download-artifact@v4
+        with:
+          name: pyproject-toml
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package
+        run: uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+
+      - name: Upload dists to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+            repo_token: ${{ secrets.GITHUB_TOKEN }}
+            file: dist/*
+            file_glob: true
+            tag: ${{ github.ref }}
+            overwrite: true
+
+      - name: Sync skills folder
+        run: bash scripts/sync-skills.sh
+
+      - name: Create SKILL.zip
+        run: |
+          mv skills pai-agent-sdk
+          zip -r SKILL.zip pai-agent-sdk
+
+      - name: Upload SKILL.zip to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+            repo_token: ${{ secrets.GITHUB_TOKEN }}
+            file: SKILL.zip
+            tag: ${{ github.ref }}
+            overwrite: true

pai_agent_sdk-0.4.1/.github/workflows/validate-codecov-config.yml

@@ -0,0 +1,15 @@
+name: validate-codecov-config
+
+on:
+  pull_request:
+    paths: [codecov.yaml]
+  push:
+    branches: [main]
+
+jobs:
+  validate-codecov-config:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Validate codecov configuration
+        run: curl -sSL --fail-with-body --data-binary @codecov.yaml https://codecov.io/validate

pai_agent_sdk-0.4.1/.gitignore

@@ -0,0 +1,145 @@
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.pyright/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Vscode config files
+# .vscode/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+TO-DO.json
+dev/
+pai_agent_sdk/sandbox/shell/templates/public

pai_agent_sdk-0.4.1/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v6.0.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: check-json
+        exclude: ^.devcontainer/devcontainer.json
+      - id: pretty-format-json
+        exclude: ^.devcontainer/devcontainer.json
+        args: [--autofix]
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+        args: [--number]
+        exclude: ^(pai_agent_sdk/.*\.md|examples/.*\.md)$
+        additional_dependencies:
+          [mdformat-gfm, mdformat-front-matters, mdformat-footnote]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.14.11"
+    hooks:
+      - id: ruff
+        args: [--exit-non-zero-on-fix]
+      - id: ruff-format

pai_agent_sdk-0.4.1/.python-version

@@ -0,0 +1 @@
+3.13

pai_agent_sdk-0.4.1/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python"
+}

pai_agent_sdk-0.4.1/AGENTS.md

@@ -0,0 +1,218 @@
+## Project Overview
+
+**pai-agent-sdk** is a Python SDK for building production-ready AI agents with [Pydantic AI](https://ai.pydantic.dev/).
+
+- **Language**: Python 3.11+
+- **Package Manager**: uv
+- **Build System**: hatchling
+
+## Key Features
+
+- **Environment-based Architecture**: Inject file operations, shell access, and resources via `Environment` for clean separation of concerns
+- **Resumable Sessions**: Export/restore `AgentContext` state for multi-turn conversations across restarts
+- **Hierarchical Agents**: Subagent system with task delegation and tool inheritance
+- **Human-in-the-Loop**: Built-in approval workflows for sensitive operations
+- **Streaming Support**: Real-time streaming of agent responses and tool executions
+
+## Project Structure
+
+```
+pai_agent_sdk/
+├── agents/                # Agent implementations
+│   ├── main.py            # create_agent, stream_agent entry points
+│   ├── compact.py         # Compact agent variant
+│   ├── image_understanding.py  # Image understanding agent
+│   ├── video_understanding.py  # Video understanding agent
+│   └── models/            # Model configuration and inference
+│
+├── context.py             # AgentContext, ModelConfig, ToolConfig, ResumableState
+│
+├── environment/           # Environment management
+│   ├── base.py            # Environment ABC, FileOperator, Shell, ResourceRegistry, BaseResource
+│   ├── local.py           # LocalEnvironment for local filesystem
+│   └── docker.py          # DockerEnvironment for container-based execution
+│
+├── toolsets/              # Tool implementations
+│   ├── core/              # Core toolsets collection
+│   │   ├── base.py        # BaseTool, Toolset, GlobalHooks (base classes)
+│   │   ├── content/       # Content loading tools
+│   │   ├── context/       # Context management tools (handoff)
+│   │   ├── document/      # Document processing tools
+│   │   ├── enhance/       # Enhancement tools (todo, thinking)
+│   │   ├── filesystem/    # File system operation tools
+│   │   ├── multimodal/    # Multimodal tools (read_image, read_video)
+│   │   ├── shell/         # Shell command execution tools
+│   │   ├── subagent/      # Subagent delegation tools
+│   │   └── web/           # Web interaction tools
+│   └── browser_use/       # Browser automation toolset (independent)
+│
+├── subagents/             # Subagent system
+│   ├── config.py          # SubagentConfig parsing
+│   ├── factory.py         # Subagent tool factory functions
+│   └── presets/           # Built-in subagent presets
+│       ├── debugger.md    # Debugging specialist
+│       ├── explorer.md    # Codebase exploration specialist
+│       ├── searcher.md    # Search specialist
+│       └── code-reviewer.md # Code review specialist
+│
+├── filters/               # Message history processors
+│   ├── handoff.py         # Handoff message processing
+│   ├── image.py           # Image filtering
+│   ├── system_prompt.py   # System prompt filtering
+│   └── tool_args.py       # Tool argument fixing
+│
+├── sandbox/               # Sandbox environments
+│   └── browser/           # Browser sandbox
+│
+├── skills/                # Skill definitions
+│   └── checkpointing/     # Checkpointing skill
+│
+├── stream/                # Stream processing
+├── presets.py             # Preset configurations (model settings, etc.)
+├── utils.py               # Utility functions
+└── _logger.py             # Centralized logging
+
+tests/                     # Test suite (pytest)
+├── environment/           # Environment tests
+├── filters/               # Filter tests
+├── sandbox/               # Sandbox tests
+├── subagents/             # Subagent tests
+└── toolsets/              # Toolset tests
+```
+
+## Development Workflow
+
+After modifying any code:
+
+1. `make lint` - Quick formatting and auto-fix (ruff + pre-commit)
+2. `make check` - Full validation (lock file, pre-commit, Pyright type checking, deptry)
+3. `make test` - Run test suite with coverage
+
+## Key Commands
+
+| Command         | Description                                         |
+| --------------- | --------------------------------------------------- |
+| `make install`  | Create venv with uv and install pre-commit hooks    |
+| `make lint`     | Run pre-commit linters (ruff format/lint)           |
+| `make check`    | Full validation: lint + pyright + deptry            |
+| `make test`     | Run pytest with coverage (inline snapshot disabled) |
+| `make test-fix` | Run pytest with inline snapshot update enabled      |
+| `make build`    | Build wheel file                                    |
+
+## Code Style
+
+- **Formatter**: ruff (line-length: 120)
+- **Type Checking**: pyright (standard mode)
+- **Target Python**: 3.11
+- **Import Style**: All imports must be at module level (top of file). Do not use function-level imports except within `TYPE_CHECKING` blocks for avoiding circular dependencies.
+
+## Testing
+
+- Framework: pytest with pytest-asyncio
+- Coverage: pytest-cov
+- Test location: `tests/`
+- **Test Style**: Use standalone functions (not classes)
+
+## Dependencies
+
+Core dependencies:
+
+- pydantic-ai-slim (AI agent framework)
+- pydantic / pydantic-settings (data validation and configuration)
+- httpx, anyio (async HTTP and concurrency)
+- cdp-use (browser automation)
+- pillow (image processing)
+- jinja2 (template rendering for tool instructions)
+
+Optional dependencies:
+
+- `docker` - Docker sandbox support
+- `web` - Web tools (tavily-python, firecrawl-py, markitdown)
+- `document` - Document processing (pymupdf, markitdown)
+
+## Environment Configuration
+
+API keys and settings are loaded from environment variables or `.env` file via `pydantic-settings`. See `.env.example` for all available variables.
+
+**Important**: When adding or modifying environment variables, always update `.env.example` as the single source of truth.
+
+## Architecture Reference
+
+### AgentContext and Sessions
+
+See [docs/context.md](docs/context.md) for details:
+
+- Session state management (run_id, timing, user prompts)
+- Resumable sessions with `export_state()` and `with_state()`
+- Extending `AgentContext` and `ResumableState` for custom fields
+- Using `create_agent` with `state` parameter for session restoration
+
+### Toolset Architecture
+
+See [docs/toolset.md](docs/toolset.md) for details:
+
+- Creating custom tools with `BaseTool`
+- Hook system (pre/post hooks, global hooks)
+- Error handling in post-hooks (exceptions as results)
+- Extending `Toolset` via `_call_tool_func` for timeout/retry/custom logic
+
+### Subagent System
+
+See [docs/subagent.md](docs/subagent.md) for details:
+
+- Hierarchical agent architecture and task delegation
+- Markdown configuration format (YAML frontmatter + system prompt)
+- Tool inheritance and availability rules
+- Built-in presets (debugger, explorer, searcher, code-reviewer)
+
+### Environment Management
+
+See [docs/environment.md](docs/environment.md) for details:
+
+- Environment ABC: FileOperator, Shell, ResourceRegistry
+- `_setup`/`_teardown` pattern for custom environments
+- `LocalEnvironment` and `DockerEnvironment` usage
+- `AsyncExitStack` for managing dependent context managers
+
+### Resumable Resources
+
+See [docs/resumable-resources.md](docs/resumable-resources.md) for details:
+
+- `Resource` protocol (requires `close()`) and `ResumableResource` protocol (adds `export_state`/`restore_state`)
+- `BaseResource` abstract base class with async `close()` and default export/restore
+- Factory-based resource creation and lazy initialization
+- State export/restore for session persistence across restarts
+
+### Model Configuration
+
+See [docs/model.md](docs/model.md) for details:
+
+- Native pydantic-ai model strings (direct provider connection)
+- Gateway mode (route requests through unified gateway)
+- Sticky routing and extra headers
+
+### Logging
+
+See [docs/logging.md](docs/logging.md) for details:
+
+- Global log level: `PAI_AGENT_LOG_LEVEL`
+- Module-specific log levels: `PAI_AGENT_LOG_LEVEL_<MODULE_PATH>`
+- Use `get_logger(__name__)` to obtain logger
+
+## Examples
+
+| Example                                     | Description                                                               |
+| ------------------------------------------- | ------------------------------------------------------------------------- |
+| [general.py](examples/general.py)           | Complete production pattern with streaming, HITL, and session persistence |
+| [deepresearch.py](examples/deepresearch.py) | Autonomous research agent with web search and content extraction          |
+| [browser_use.py](examples/browser_use.py)   | Browser automation with Docker-based headless Chrome sandbox              |
+
+## Quick Start
+
+```python
+from pai_agent_sdk.agents import create_agent
+
+async with create_agent("openai:gpt-4o") as runtime:
+    result = await runtime.agent.run("Hello", deps=runtime.ctx)
+    print(result.output)
+```

pai_agent_sdk-0.4.1/CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md