summaryrefslogtreecommitdiffhomepage
path: root/packages/sdk/python/docs/usage/streaming.md
diff options
context:
space:
mode:
authorKevin King <[email protected]>2025-10-28 19:32:45 -0400
committerGitHub <[email protected]>2025-10-28 18:32:45 -0500
commit0e60f666043910afb96e9de2f84b0b8a68c7e4d6 (patch)
tree6ca20af712e2faca6262f029d6d8499c9888eb50 /packages/sdk/python/docs/usage/streaming.md
parentfc8db6cdf9cb81e29c5dda69c8646aa52e453a9c (diff)
downloadopencode-0e60f666043910afb96e9de2f84b0b8a68c7e4d6.tar.gz
opencode-0e60f666043910afb96e9de2f84b0b8a68c7e4d6.zip
ignore: python sdk (#2779)
Co-authored-by: Aiden Cline <[email protected]>
Diffstat (limited to 'packages/sdk/python/docs/usage/streaming.md')
-rw-r--r--packages/sdk/python/docs/usage/streaming.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/packages/sdk/python/docs/usage/streaming.md b/packages/sdk/python/docs/usage/streaming.md
new file mode 100644
index 000000000..31066e8de
--- /dev/null
+++ b/packages/sdk/python/docs/usage/streaming.md
@@ -0,0 +1,29 @@
+# Streaming (SSE)
+
+Subscribe to the event stream. The wrapper provides both sync and async interfaces.
+
+```python
+from opencode_ai import OpenCodeClient
+
+client = OpenCodeClient()
+
+# Sync streaming
+for event in client.subscribe_events():
+ print(event)
+ break
+```
+
+Async variant:
+
+```python
+import asyncio
+from opencode_ai import OpenCodeClient
+
+async def main():
+ client = OpenCodeClient()
+ async for event in client.subscribe_events_async():
+ print(event)
+ break
+
+asyncio.run(main())
+```