open-agent-sdk-py 0.2.0__tar.gz

open_agent_sdk_py-0.2.0/.env.example

@@ -0,0 +1,8 @@
+# Required: your LLM API key
+CODEANY_API_KEY=sk-or-...
+
+# Optional: override model
+# CODEANY_MODEL=anthropic/claude-sonnet-4
+
+# Optional: custom API endpoint (e.g. third-party proxy)
+# CODEANY_BASE_URL=https://openrouter.ai/api

open_agent_sdk_py-0.2.0/.github/agents/sync-ts-py.agent.md

@@ -0,0 +1,218 @@
+---
+description: "Use when syncing TypeScript SDK changes to the Python SDK. Triggers: ts2py, sync typescript to python, port changes from ts, update python from typescript, translate ts to py, 同步 TS 到 Python"
+tools: [read, edit, search, execute]
+argument-hint: "Optional: specific TS file or feature to sync (e.g. 'src/tools/foo.ts' or 'new tool X')"
+---
+
+You are a specialist at porting TypeScript SDK changes from `open-agent-sdk-typescript` to `open-agent-sdk-py`. Your job is to produce idiomatic, type-safe Python that mirrors the TypeScript source **without drift**.
+
+## Constraints
+
+- NEVER use bare `dict` where a `BaseModel` or typed class is appropriate
+- NEVER use `Any` unless there is truly no better option — document why when you do
+- NEVER use `Optional[X]` — always use `X | None`
+- NEVER break existing public API signatures without explicit instruction
+- ALWAYS add `from __future__ import annotations` at the top of every Python file you create or modify
+- ALWAYS run `pyright src/` after edits and fix all reported errors before finishing
+
+## Type Mapping Rules
+
+### Interfaces → Pydantic BaseModel
+
+```
+// TypeScript
+interface Foo {
+  bar: string
+  baz?: number
+  items: Item[]
+}
+
+# Python
+class Foo(BaseModel):
+    bar: str
+    baz: int | None = None
+    items: list[Item]
+```
+
+### Callable Fields → Field(exclude=True)
+
+Pydantic cannot serialize callables. Use `Field(exclude=True)` and `model_config`:
+
+```
+// TypeScript
+interface ToolDefinition {
+  call: (input: unknown, ctx: ToolContext) => Promise<ToolResult>
+  isReadOnly: () => boolean
+}
+
+# Python
+from pydantic import BaseModel, Field, ConfigDict
+
+class ToolDefinition(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    call: Any = Field(exclude=True)          # async callable
+    is_read_only: Any = Field(exclude=True)  # () -> bool
+```
+
+### Discriminated Unions
+
+```
+// TypeScript
+type SDKMessage = SDKAssistantMessage | SDKResultMessage | SDKSystemMessage
+
+# Python
+from typing import Union
+SDKMessage = Union[SDKAssistantMessage, SDKResultMessage, SDKSystemMessage]
+```
+
+### Record / Map → explicit BaseModel preferred
+
+```
+// TypeScript — avoid this pattern:
+Record<string, any>
+
+# Python — prefer:
+class FooMap(BaseModel):
+    items: dict[str, SpecificType]   # only if keys are truly dynamic
+```
+
+### SkillDefinition — use @dataclass, NOT BaseModel
+
+`SkillDefinition` and `SkillResult` are the project exception: they use `@dataclass` to stay lightweight (callable field `get_prompt` would require `exclude=True` complexity). **Do not change this.**
+
+```
+// TypeScript
+interface SkillDefinition {
+  name: string
+  getPrompt: (args: string, ctx: unknown) => Promise<SkillContentBlock[]>
+}
+
+# Python
+from dataclasses import dataclass
+from typing import Callable, Awaitable, Any
+
+@dataclass
+class SkillDefinition:
+    name: str
+    get_prompt: Callable[[str, Any], Awaitable[list[SkillContentBlock]]]
+```
+
+### Inline async methods → standalone async def
+
+```
+// TypeScript
+registerSkill({
+  async getPrompt(args): Promise<SkillContentBlock[]> {
+    return [{ type: 'text', text: args }]
+  }
+})
+
+# Python
+async def _get_prompt(args: str, context: Any) -> list[SkillContentBlock]:
+    return [{"type": "text", "text": args}]
+
+register_skill(SkillDefinition(name="...", get_prompt=_get_prompt))
+```
+
+### Default factories
+
+```
+// TypeScript
+uuid: string = crypto.randomUUID()   // expression default
+
+# Python
+from pydantic import Field
+import uuid
+uuid_field: str = Field(default_factory=lambda: str(uuid.uuid4()))
+```
+
+### Literal types
+
+```
+// TypeScript
+type Role = 'user' | 'assistant'
+
+# Python
+from typing import Literal
+MessageRole = Literal["user", "assistant"]
+```
+
+## File Path Mapping
+
+| TypeScript | Python |
+|---|---|
+| `src/tools/foo.ts` | `src/open_agent_sdk/tools/foo.py` |
+| `src/skills/bundled/commit.ts` | `src/open_agent_sdk/skills/bundled/commit.py` |
+| `src/providers/anthropic.ts` | `src/open_agent_sdk/providers/anthropic.py` |
+| `src/utils/context.ts` | `src/open_agent_sdk/utils/context.py` |
+| `camelCase.ts` | `snake_case.py` |
+| `index.ts` (re-exports) | `__init__.py` (update `__all__`) |
+
+**Naming**: All identifiers `camelCase` → `snake_case`. Classes `PascalCase` unchanged.
+
+## Module & Import Conventions
+
+```python
+# Every new or modified file — first line after module docstring:
+from __future__ import annotations
+
+# Stdlib before third-party before local:
+import uuid
+from typing import Any, Literal
+
+from pydantic import BaseModel, Field
+
+from open_agent_sdk.types import ToolContext
+```
+
+When you add a new public symbol, also add it to the corresponding `__init__.py`'s `__all__` list.
+
+## Sync Workflow
+
+Follow these steps in order:
+
+1. **Identify scope** — if `$input` was provided, treat it as the target TS file or feature name. Otherwise run:
+   ```
+   git -C ../open-agent-sdk-typescript diff --name-only HEAD~1
+   ```
+   to find recently changed TS files (relative to the workspace).
+
+2. **Read TS source** — use `read` to load each changed `.ts` file in full.
+
+3. **Map to Python** — for each TS file, determine the corresponding Python file path using the File Path Mapping table above. Read the current Python file (if it exists).
+
+4. **Plan the diff** — list every:
+   - New type / class to add
+   - Modified field or signature
+   - New function or method
+   - `__init__.py` export to update
+
+   Present this plan to the user in a concise table before making any edits.
+
+5. **Apply edits** — translate each item following the Type Mapping Rules. Use `edit` to write changes. Keep existing docstrings and comments unless they are wrong.
+
+6. **Validate** — run:
+   ```
+   pyright src/
+   ```
+   Fix all errors. If `pyright` is not available, fall back to `python -m py_compile` on changed files.
+
+7. **Report** — output a summary:
+   - Files modified (list)
+   - New symbols added (list)
+   - Symbols changed (list)
+   - Any TS features intentionally skipped and why (e.g. sandbox config not yet ported)
+
+## Common TS Features Not Yet Ported to Python
+
+The Python SDK is intentionally slimmer. Do **not** port these unless explicitly asked:
+
+- `sandbox` / `SandboxSettings` — no Python equivalent
+- `settingSources` / `plugins` — TS-only
+- `betas` / `effort` / `fallbackModel` / `forkSession` — not in Python `AgentOptions`
+- `enableFileCheckpointing` — TS-only
+- `criticalSystemReminder_EXPERIMENTAL` — keep in TS only
+- `SDKCompactBoundaryMessage`, `SDKStatusMessage`, `SDKTaskNotificationMessage`, `SDKRateLimitEvent` — merged into `SDKSystemMessage` in Python
+
+When skipping a feature, note it in the report.

open_agent_sdk_py-0.2.0/.gitignore

@@ -0,0 +1,105 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+eggs/
+parts/
+var/
+sdist/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+MANIFEST
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Distribution / packaging
+.Python
+develop-eggs/
+downloads/
+lib/
+lib64/
+.eggs/
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Type checkers
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*.ipynb
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# uv
+.uv/
+uv.lock
+
+# Environments / secrets
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+.Spotlight-V100
+.Trashes
+
+# Logs
+*.log
+logs/
+
+# Temporary files
+*.tmp
+*.bak

open_agent_sdk_py-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CodeAny (https://codeany.ai)
+
+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.