opencode-python-sdk 0.1.0__py3-none-any.whl

opencode_python_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,317 @@
+Metadata-Version: 2.5
+Name: opencode-python-sdk
+Version: 0.1.0
+Summary: Typed Python client for the OpenCode 2.x server API
+Project-URL: Homepage, https://github.com/shrijayan/opencode-python-sdk
+Project-URL: Documentation, https://github.com/shrijayan/opencode-python-sdk#readme
+Project-URL: Repository, https://github.com/shrijayan/opencode-python-sdk
+Project-URL: Issues, https://github.com/shrijayan/opencode-python-sdk/issues
+Project-URL: Changelog, https://github.com/shrijayan/opencode-python-sdk/blob/main/CHANGELOG.md
+Author: Shrijayan Rajendran
+License-Expression: MIT
+License-File: LICENSE
+Keywords: agents,ai,client,coding-agent,opencode,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Pydantic :: 2
+Classifier: Framework :: Trio
+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 :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: anyio<5,>=4.4
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.12
+Requires-Dist: typing-extensions>=4.12
+Description-Content-Type: text/markdown
+
+# opencode-python-sdk
+
+[![CI](https://github.com/shrijayan/opencode-python-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/shrijayan/opencode-python-sdk/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/opencode-python-sdk.svg)](https://pypi.org/project/opencode-python-sdk/)
+[![Python](https://img.shields.io/pypi/pyversions/opencode-python-sdk.svg)](https://pypi.org/project/opencode-python-sdk/)
+
+Typed Python client for the [OpenCode](https://github.com/anomalyco/opencode) 2.x server API.
+
+> **Unofficial, community-maintained.** This package is not affiliated with or endorsed by the OpenCode team.
+> If the OpenCode maintainers want to take it over, we are happy to transfer this repository and the `opencode-python-sdk`
+> name on PyPI. Open an issue and we will hand it over.
+
+- **Complete.** All 142 operations of the OpenCode 2.1 API, sync and async, with typed models for every request,
+  response and event (96 event types).
+- **Generated from the source of truth.** The contract is exported from the same Effect `HttpApi` the official
+  TypeScript client is built from, so method names and request shapes match it exactly.
+- **Safe to run in production.** Retries only when a request cannot have changed server state, bounded backoff that
+  honors `Retry-After`, typed errors for every declared server error, and timeouts on everything.
+- **Forward compatible.** New fields, enum values, union variants and event types from newer servers are kept, not
+  rejected, so an older client keeps working after a server upgrade.
+- **Batteries included.** Starts and stops `opencode serve` for you, auto-paginates lists, and streams events.
+
+## Install
+
+```bash
+pip install opencode-python-sdk
+```
+
+The package imports as `opencode`. Requires Python 3.10 or newer. To start a server from Python, install the [OpenCode CLI](https://opencode.ai) too.
+
+## Quick start
+
+```python
+from opencode import OpencodeServer
+
+with OpencodeServer(cwd="/path/to/repo") as server, server.client() as client:
+    session = client.session.create(title="Review")
+    client.session.prompt(session.id, text="Summarize the open TODOs in this repository")
+    client.session.wait(session.id)
+
+    for message in client.message.list(session.id):
+        print(message.type)
+```
+
+To connect to a server that is already running:
+
+```python
+from opencode import Opencode
+
+client = Opencode("http://127.0.0.1:4096", password="...")
+print(client.server.info().version)
+```
+
+`base_url` and `password` default to the `OPENCODE_BASE_URL` and `OPENCODE_PASSWORD` environment variables. The
+password variable is the same one the OpenCode CLI reads.
+
+## Async
+
+`AsyncOpencode` has the same methods. It works with asyncio and trio.
+
+```python
+import asyncio
+
+from opencode import AsyncOpencode
+
+
+async def main() -> None:
+    async with AsyncOpencode("http://127.0.0.1:4096", password="...") as client:
+        session = await client.session.create(title="Async")
+        await client.session.prompt(session.id, text="Hello")
+
+        async for message in client.message.list(session.id):
+            print(message.type)
+
+
+asyncio.run(main())
+```
+
+## Calling the API
+
+Methods mirror the official TypeScript client: `client.<group>.<operation>()`, with names in `snake_case`. Path
+parameters are positional; everything else is keyword-only.
+
+```python
+client.session.get("ses_...")
+client.session.prompt("ses_...", text="Fix the failing test", resume=True)
+client.session.revert.stage("ses_...", message_id="msg_...")
+client.mcp.list()
+```
+
+The full list is in [api.md](api.md).
+
+### Optional and null arguments
+
+The server distinguishes a field that is absent from a field set to `null`. Optional arguments default to
+`NOT_GIVEN` and are left out of the request; passing `None` sends `null`:
+
+```python
+client.session.update("ses_...", title="New title")  # sends {"title": "New title"}
+client.session.list(parent_id=None)  # only root sessions: parentID=null
+```
+
+### Models
+
+Responses are [pydantic](https://docs.pydantic.dev) models. Attributes are `snake_case`; the wire names stay
+available as aliases, so a model validates server JSON and serializes back to it unchanged.
+
+```python
+from opencode.types import ModelRef
+
+session = client.session.create(model=ModelRef(id="claude-sonnet-5-5", provider_id="anthropic"))
+session.project_id  # attribute access
+session.to_dict()  # {"id": "...", "projectID": "...", ...}
+```
+
+Unions are discriminated, so `isinstance` and `match` narrow them:
+
+```python
+from opencode.types import SessionMessageAssistant, SessionMessageUser
+
+for message in client.message.list(session.id):
+    match message:
+        case SessionMessageUser(text=text):
+            print("user:", text)
+        case SessionMessageAssistant():
+            print("assistant replied")
+        case _:
+            pass  # includes variants added by newer servers
+```
+
+### Project directory
+
+Most endpoints take a `location`. Set a default for the client once:
+
+```python
+client = Opencode("http://127.0.0.1:4096", directory="/path/to/repo")
+client.agent.list()  # uses /path/to/repo
+client.agent.list(location={"directory": "/other"})  # per call
+```
+
+## Pagination
+
+List endpoints with cursors return a page. Iterating it fetches the following pages as needed.
+
+```python
+for session in client.session.list(limit=50):
+    print(session.title)
+
+page = client.session.list(limit=50)
+page.data  # this page only
+page.has_next_page()
+next_page = page.next_page()
+```
+
+Async list methods return a paginator: `await` it for the first page, or `async for` over every item.
+
+## Events
+
+```python
+with client.event.subscribe() as events:
+    for event in events:
+        print(event.type)
+```
+
+Events are typed (`SessionCreatedEvent`, `SessionTextDeltaEvent`, and so on). Event types this client version does
+not know arrive as `UnknownEvent` with all their fields kept. Streams apply only the connect timeout by default, since
+they stay open between events.
+
+## Errors
+
+Every error derives from `opencode.OpencodeError`. Errors the server declares are raised as their own class, with a
+typed body:
+
+```python
+import opencode
+
+try:
+    client.session.get("ses_missing")
+except opencode.SessionNotFoundError as error:
+    print(error.error.session_id, error.status_code)
+except opencode.NotFoundError:
+    ...  # any other 404
+except opencode.APIConnectionError:
+    ...  # server unreachable
+```
+
+| Status | Class |
+| --- | --- |
+| 400 | `BadRequestError` |
+| 401 | `AuthenticationError` |
+| 403 | `PermissionDeniedError` |
+| 404 | `NotFoundError` |
+| 409 | `ConflictError` |
+| 413 | `ContentTooLargeError` |
+| 429 | `RateLimitError` |
+| 5xx | `InternalServerError` |
+| No response | `APIConnectionError`, `APITimeoutError` |
+| Unexpected body | `APIResponseValidationError` |
+
+## Retries and timeouts
+
+The client retries twice by default, with exponential backoff and jitter, and honors `Retry-After` up to 60 seconds.
+
+- `GET`, `PUT` and `DELETE` are retried on connection errors and on 408, 429, 500, 502, 503 and 504.
+- `POST` and `PATCH` are retried only when the request cannot have run: when the connection could not be opened, or
+  on 429 and 503. A prompt is never sent twice because a response was slow.
+
+```python
+client = Opencode(max_retries=5, timeout=30.0)
+client.with_options(timeout=None).session.wait(session.id)  # wait as long as it takes
+client.session.get("ses_...", timeout=5.0)  # per call
+```
+
+The default timeout is 10 minutes with a 10 second connect timeout.
+
+## Running a server
+
+`OpencodeServer` runs `opencode serve` as a child process on a free local port with a random password:
+
+```python
+from opencode import OpencodeServer
+
+server = OpencodeServer(
+    cwd="/path/to/repo",
+    isolated=True,  # ignore project opencode.json, AGENTS.md and Claude Code files
+    config={"model": "anthropic/claude-sonnet-5-5"},  # passed as OPENCODE_CONFIG_CONTENT
+)
+with server:
+    client = server.client()
+    ...
+```
+
+The server runs in `--stdio` mode, so it also exits when the Python process dies. `AsyncOpencodeServer` is the
+async equivalent.
+
+## Advanced
+
+```python
+import httpx
+
+from opencode import Opencode
+
+client = Opencode(
+    "https://opencode.internal.example.com",
+    http_client=httpx.Client(proxy="http://proxy:8080", verify="/etc/ssl/ca.pem"),
+    default_headers={"X-Team": "platform"},
+)
+
+client.session.create(title="t", extra_headers={"X-Trace": "1"}, extra_body={"future": True})
+```
+
+Logs go to the `opencode` logger. `logging.getLogger("opencode").setLevel(logging.DEBUG)` shows every request and
+retry; credentials are never logged.
+
+## Versioning
+
+| `opencode-python-sdk` (this package) | OpenCode server |
+| --- | --- |
+| 0.1.x | 2.1.x |
+
+`opencode.API_VERSION` is the server version the client was generated from. The package follows semantic
+versioning and releases automatically on every merge to `main`; until 1.0, minor versions may contain breaking
+changes. See the [releases page](https://github.com/shrijayan/opencode-python-sdk/releases).
+
+## How it is built
+
+```
+@opencode/protocol (npm)  ──bun codegen/extract──▶  spec/contract.json  ──python -m codegen──▶  src/opencode
+```
+
+1. `codegen/extract/extract.ts` loads `ClientApi` from the published `@opencode/protocol` package and exports
+   every endpoint, its inputs, outputs and declared errors, and every schema as JSON Schema.
+2. `python -m codegen` turns the contract into pydantic models (`opencode/types`), resources
+   (`opencode/resources`), error classes (`opencode/_errors.py`) and [api.md](api.md).
+3. The transport, retries, streaming, pagination and server launcher are written by hand.
+
+Generated code is committed. CI regenerates it and fails if anything changed. See
+[CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+MIT

opencode_python_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,55 @@
+opencode/.generated.json,sha256=QNCFazAYhcwsGf0l4A2EeSpm2HOM7TRBE648Zyoeq_s,1383
+opencode/__init__.py,sha256=UGraxBEfh90WBSAQ7ccwxJsXE5AxYDDTyKlcXhqzykc,4106
+opencode/_base_client.py,sha256=3BwhIXL-cFGoRUuwDzTeFH21O7pihUR5CryOlS1Wylo,20108
+opencode/_client.py,sha256=ip-UhWyHTViMnqgX3jhUmCkscahFtXnIWM2Jd2zn61I,6723
+opencode/_constants.py,sha256=-B_D8RHElL4mYN__WVf4bag4D12dJHbL69_EMfi7bXo,1132
+opencode/_errors.py,sha256=dWjsyGV0aDBKsvJrGNKGJn41Yue66yBBwGTT2pTV7E8,16431
+opencode/_exceptions.py,sha256=-a4nw3bKU239kn6boBAcw7Fszw6nF1mqzHFJKEcX-Pc,7996
+opencode/_models.py,sha256=2esvD2CmslOHCbuLNkN0sGDcgMAqeoMmB7hZMPzo1uA,1988
+opencode/_pagination.py,sha256=uvB-0IwfkGqbYIYiUW_ax_oAE-ldZJSWHtjluVcZlNk,7052
+opencode/_qs.py,sha256=8EWbLzd-iLComngGRyO95f_z76j4tUeBihYJdHI5NP8,3643
+opencode/_resource.py,sha256=ovuG85mWcuXNTu5m6H9FKPN2rrD5o52oRFAGBHimPyg,1263
+opencode/_server.py,sha256=o_YgzX8x2gUuWXbOKptgF-7AJPhjN8T-1pCzmUSKelw,12297
+opencode/_streaming.py,sha256=OJJNoFdvx6degaVnnQNhv9augigImoYjGzEdnI3FVkk,7905
+opencode/_types.py,sha256=Z8bYxzpZhPRtisvPUv9R5g4oBlC23iXR70fFzReTOc0,2194
+opencode/_unions.py,sha256=dW0dTmP2QK2lL6RhyK2YsjD2yNbO8Ah6pk-i5ySW3lo,1518
+opencode/_version.py,sha256=zNErHu8z_g6ScOeYcO8QAiktg036FVPaUiIIZefeoLU,259
+opencode/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+opencode/resources/__init__.py,sha256=wNPQqEDgNYedtWhub2wVWL85jEoE2qCQQHks5WHyAoM,13239
+opencode/resources/agent.py,sha256=Dm1RUA00EiF2nh4GBMjPj-dDxfN_cplcpV0fvokwnzw,5194
+opencode/resources/command.py,sha256=XWclziA5le4bwXhgGP3FDvBL-n8SECqT3qCtZlUn6Bk,2863
+opencode/resources/config.py,sha256=o8Ep5qkD5Dz3P7_Q7j2rmkWLo1iky3tgcfTLAZusnec,7169
+opencode/resources/credential.py,sha256=fTaS-Zz48U6QN0rKuMIVF4mn_7YO5BKoJxmpEr5GoNc,11446
+opencode/resources/debug.py,sha256=PK9BAURu_E66wgrS_8NgWvoviFnwBM5w0ZQgED_3UAs,5159
+opencode/resources/event.py,sha256=1r0lWil6rbN-NOWhZlLmrxrvoAeqtMpqyBrHqXgEAKo,2590
+opencode/resources/experimental.py,sha256=MijdyFk6cYyFNFmigb6eBdWtiKaRJyismTWCpbMzAHo,25947
+opencode/resources/file.py,sha256=cDn1cMCXBUY8EMImvpRwdzLIUBwbOIeRGNVuBsnMa04,12215
+opencode/resources/form.py,sha256=AunzhyF3zBT8Y_e8vZlDKe8EVAHLO5kaKTI2QYwIYAk,2811
+opencode/resources/generate.py,sha256=pSRD_s0vAe2EOfRndXCwauG63l-u0WKVNXQQM0tS700,3547
+opencode/resources/integration.py,sha256=dQIjpRt2SPPFhgIDijjFTSKRGJEhWv2-xFqwYawYR1g,34861
+opencode/resources/location.py,sha256=ZbuH1IGRBI84VeIg6QYTPBZk7BX0SOuemzIs6_VEYhQ,4991
+opencode/resources/mcp.py,sha256=IDSfsLNGUEDWRZOXKo5cKosUge42MyQLT1_vdbXvlEU,15131
+opencode/resources/message.py,sha256=6noqDNBLqOsqXye5ijU-aAKhY8yjLeb3Y9531oDcx24,5686
+opencode/resources/migration.py,sha256=6GjaHwj1wGpOjjkbYc-G-32EdwiZZc0V_CIUxKu-KvY,4042
+opencode/resources/model.py,sha256=QcpIcE4kLumV8RhFlz4nq0UqoXLgOCq71RON8wFFIos,5397
+opencode/resources/permission.py,sha256=wMi2ifGzazbQ3AJ1uuVYrqbpLbf5Bqx9HZpjVwuQkqQ,22506
+opencode/resources/plugin.py,sha256=2yVeINHnwNVHi6YQPqcCJ7uJnUwfEdwSqvaPOiLzi0k,7639
+opencode/resources/project.py,sha256=ZCRWQdSSk6YvVz_J98Rs92woe6Ts8sTEmfJxVUqQSvU,5750
+opencode/resources/provider.py,sha256=SBJdP0SDf7qiDwxYGlu45-jTuppU4yYyg52WEtHZvVs,5666
+opencode/resources/pty.py,sha256=jOX2CrFO-grFz3kr5BCr-dVIivj1JDulkMGOIQqceVw,16174
+opencode/resources/reference.py,sha256=iiDzB6rfooys1O6rZIGL4dW07HpS8nYu0-G83AsUtIo,2933
+opencode/resources/rpc.py,sha256=4Q7jkLWa4dKG8n-foWtMp-b9QU5S8B3xi_qFc7t7GXA,3370
+opencode/resources/server.py,sha256=hGtDtm3vPzghvR_U5CihpdIr5sEbdcdxz_4EbdqgCJU,6620
+opencode/resources/session.py,sha256=9adcy6D0I7cFlpntOyxxEHX2CdDEyJz0SJlfjWfykgI,116310
+opencode/resources/shell.py,sha256=UHQvJCGJWKkywsRx-5-wriGaczr9NIkYuy1ZArZeMxA,12945
+opencode/resources/skill.py,sha256=w06gWcoempzGaFqVFMQZJ3EOyga6q6-gEbACAcRw9JQ,2815
+opencode/resources/vcs.py,sha256=_00yFMlt6SjSft7GRBdhdr0KAruLjFmuNGk5cMFadU4,16417
+opencode/resources/voice.py,sha256=N6v_Eeg3G5PCAzCgup2CnIAuZD-0-JNMqAIV5dsFYmQ,3726
+opencode/resources/websearch.py,sha256=spYgRg0SoC6bhvk7ZVKzrPkRJ9UZvY9DSTT7hRmNHxE,5789
+opencode/resources/worktree.py,sha256=jlBa4RuocApapVAMLr4qnUhc2e_AdFeVoPXGxJPIGiM,10170
+opencode/types/__init__.py,sha256=5JEAe89RPSwJw1yz0kufBxtEJgRsMpZXj7KTbzGX45A,60935
+opencode/types/_generated.py,sha256=c3zBAfVpZGJ9TX4FqrMZASmoxRntel_QzVuP85BOJwU,235015
+opencode_python_sdk-0.1.0.dist-info/METADATA,sha256=VuwTwpUpnuei27jYXrDjUHRvRskei1k4bKv5BtsUBFA,11316
+opencode_python_sdk-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+opencode_python_sdk-0.1.0.dist-info/licenses/LICENSE,sha256=SbiOG1an_-gZ0gwGLS0tsbUnMHA7tYX22FgP1EqzrH4,1093
+opencode_python_sdk-0.1.0.dist-info/RECORD,,

opencode_python_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

opencode_python_sdk-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shrijayan Rajendran and contributors
+
+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.