diff options
| author | Kevin King <[email protected]> | 2025-10-28 19:32:45 -0400 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-10-28 18:32:45 -0500 |
| commit | 0e60f666043910afb96e9de2f84b0b8a68c7e4d6 (patch) | |
| tree | 6ca20af712e2faca6262f029d6d8499c9888eb50 /packages/sdk/python/docs/generation.md | |
| parent | fc8db6cdf9cb81e29c5dda69c8646aa52e453a9c (diff) | |
| download | opencode-0e60f666043910afb96e9de2f84b0b8a68c7e4d6.tar.gz opencode-0e60f666043910afb96e9de2f84b0b8a68c7e4d6.zip | |
ignore: python sdk (#2779)
Co-authored-by: Aiden Cline <[email protected]>
Diffstat (limited to 'packages/sdk/python/docs/generation.md')
| -rw-r--r-- | packages/sdk/python/docs/generation.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/packages/sdk/python/docs/generation.md b/packages/sdk/python/docs/generation.md new file mode 100644 index 000000000..f949760a1 --- /dev/null +++ b/packages/sdk/python/docs/generation.md @@ -0,0 +1,19 @@ +# Generation workflow + +The SDK is generated from the Opencode server's OpenAPI 3.1 spec. + +Two source modes are supported: +- CLI (default): runs `bun dev generate` to emit the OpenAPI JSON +- Server: fetches `http://localhost:4096/doc` from a running server + +Generator command +```bash +# From repo root +uv run --project packages/sdk/python python packages/sdk/python/scripts/generate.py --source cli +# Or +uv run --project packages/sdk/python python packages/sdk/python/scripts/generate.py --source server --server-url http://localhost:4096/doc +``` + +Post-generation +- The generator injects `extras.py` (OpenCodeClient) and patches `__init__.py` to export it +- Code is formatted with `ruff` (imports) and `black` |