summaryrefslogtreecommitdiffhomepage
path: root/packages/sdk/python/README.md
diff options
context:
space:
mode:
authorDavid Hill <[email protected]>2025-11-10 13:44:12 +0000
committerDavid Hill <[email protected]>2025-11-10 13:44:12 +0000
commitc6e830c954418808dc39284a1c073aa63a6d4d21 (patch)
tree9c3052e0509115188768a553c0be5a8441ebdd96 /packages/sdk/python/README.md
parent7088bfabd773e2f076aab1c9d2468c04feff0570 (diff)
parentfc78c28df64383a9f99382093f61fc28caf6569f (diff)
downloadopencode-c6e830c954418808dc39284a1c073aa63a6d4d21.tar.gz
opencode-c6e830c954418808dc39284a1c073aa63a6d4d21.zip
Merge branch 'dev' of https://github.com/sst/opencode into dev
Diffstat (limited to 'packages/sdk/python/README.md')
-rw-r--r--packages/sdk/python/README.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/packages/sdk/python/README.md b/packages/sdk/python/README.md
index a17c36ab3..5d54434af 100644
--- a/packages/sdk/python/README.md
+++ b/packages/sdk/python/README.md
@@ -2,50 +2,59 @@
This package provides a Python SDK for the Opencode API. It is generated using openapi-python-client (not Stainless).
-
Documentation
+
- Full docs: see `mkdocs` site under `packages/sdk/python/docs/`
- Preview locally:
+
```bash
uv run --project packages/sdk/python mkdocs serve -f packages/sdk/python/mkdocs.yml
```
Badges
+
- PyPI: https://img.shields.io/pypi/v/opencode-ai?style=flat-square
Requirements
+
- Python 3.8+
- uv (recommended) -> https://docs.astral.sh/uv/
- openapi-python-client (invoked via `uvx`)
Install uv
+
```bash
# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
```
Set up the environment (from this directory)
+
```bash
uv sync --dev
```
Generate client code (from CLI-generated spec)
+
```bash
# From repository root OR from this directory
uv run python packages/sdk/python/scripts/generate.py --source cli
```
Alternatively, fetch spec from a running server
+
```bash
uv run python packages/sdk/python/scripts/generate.py --source server --server-url http://localhost:4096/doc
```
This will:
-1) Produce an OpenAPI spec from the local CLI or a running server
-2) Run openapi-python-client (via `uvx`) to generate client code
-3) Copy the generated Python package into src/opencode_ai
+
+1. Produce an OpenAPI spec from the local CLI or a running server
+2. Run openapi-python-client (via `uvx`) to generate client code
+3. Copy the generated Python package into src/opencode_ai
Usage (after generation)
+
```python
from opencode_ai import OpenCodeClient
@@ -77,6 +86,7 @@ client = OpenCodeClient(retries=2, backoff_factor=0.1)
```
Notes
+
- We intentionally do not use Stainless for the Python SDK.
- The generator targets OpenAPI 3.1 emitted by the opencode server at /doc.
- See scripts/generate.py for details and customization points.