mirror of
https://github.com/aljazceru/opencode.git
synced 2025-12-19 16:54:22 +01:00
ignore: python sdk (#2779)
Co-authored-by: Aiden Cline <aidenpcline@gmail.com>
This commit is contained in:
21
packages/sdk/python/docs/usage/configuration.md
Normal file
21
packages/sdk/python/docs/usage/configuration.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Configuration
|
||||
|
||||
OpenCodeClient accepts common options for auth, timeouts, and retries.
|
||||
|
||||
```python
|
||||
from opencode_ai import OpenCodeClient
|
||||
|
||||
client = OpenCodeClient(
|
||||
base_url="http://localhost:4096",
|
||||
token="pypi-or-other-token",
|
||||
auth_header_name="Authorization",
|
||||
auth_prefix="Bearer",
|
||||
timeout=30.0, # seconds
|
||||
retries=2,
|
||||
backoff_factor=0.2, # exponential backoff
|
||||
)
|
||||
```
|
||||
|
||||
- Auth: sets the header `{auth_header_name}: {auth_prefix} {token}` when `token` is provided
|
||||
- Retries: retry on transient httpx.RequestError and 429/5xx
|
||||
- Timeouts: passed to httpx.Timeout
|
||||
22
packages/sdk/python/docs/usage/files_projects.md
Normal file
22
packages/sdk/python/docs/usage/files_projects.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Files & Projects
|
||||
|
||||
Access file status and project information.
|
||||
|
||||
```python
|
||||
from opencode_ai import OpenCodeClient
|
||||
|
||||
client = OpenCodeClient()
|
||||
|
||||
# Projects
|
||||
for p in client.list_projects() or []:
|
||||
print(p.id, p.directory)
|
||||
|
||||
# Current path
|
||||
pinfo = client.get_path()
|
||||
print(pinfo.directory)
|
||||
|
||||
# File status
|
||||
files = client.file_status() or []
|
||||
for f in files:
|
||||
print(f.path, f.type)
|
||||
```
|
||||
18
packages/sdk/python/docs/usage/sessions.md
Normal file
18
packages/sdk/python/docs/usage/sessions.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Sessions
|
||||
|
||||
List sessions and inspect them. The wrapper exposes a convenience method while the generated API remains available under `opencode_ai.api.default`.
|
||||
|
||||
```python
|
||||
from opencode_ai import OpenCodeClient
|
||||
from opencode_ai.api.default import session_list as generated
|
||||
|
||||
client = OpenCodeClient()
|
||||
|
||||
# Wrapper
|
||||
sessions = client.list_sessions() or []
|
||||
|
||||
# Generated function
|
||||
sessions2 = generated.sync(client=client.client)
|
||||
|
||||
print(len(sessions), len(sessions2))
|
||||
```
|
||||
29
packages/sdk/python/docs/usage/streaming.md
Normal file
29
packages/sdk/python/docs/usage/streaming.md
Normal file
@@ -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())
|
||||
```
|
||||
Reference in New Issue
Block a user