summaryrefslogtreecommitdiffhomepage
path: root/packages/sdk/python/README.md
diff options
context:
space:
mode:
authorDax Raad <[email protected]>2025-11-06 13:03:02 -0500
committerDax Raad <[email protected]>2025-11-06 13:03:12 -0500
commit1ea3a8eb9beeb7d510fd29164ea741acec1ee04d (patch)
tree22c35a0003c6c2cfb998431f8e5180879cbab9d3 /packages/sdk/python/README.md
parent8729edc5e059a9a29346044b016a6e05d9aca835 (diff)
downloadopencode-1ea3a8eb9beeb7d510fd29164ea741acec1ee04d.tar.gz
opencode-1ea3a8eb9beeb7d510fd29164ea741acec1ee04d.zip
big format
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.