Update Python SDK documentation for v0.0.106 async transition #232
Conversation
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=80&v=4){kind=small}
- Add v0.0.106 changelog entry with breaking changes section matching JS SDK format - Update all Python SDK examples to use async patterns (await req.data.json()) - Update core-concepts.mdx to document async API patterns - Update api-reference.mdx examples to use async patterns - Mirror JavaScript SDK's⚠️ Breaking Changes format with diff examples Co-Authored-By: Parteek Singh <parteek.singh24@gmail.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
WalkthroughDocumentation and example code for the Agentuity Python SDK were updated to reflect a breaking change: data accessors such as Changes
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | 1ce672f | Commit Preview URL Branch Preview URL |
Jul 14 2025, 07:32 PM |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (2)
content/SDKs/python/core-concepts.mdx (1)
24-32: Fix JS-style dictionary in Python example
{ message: 'Hello from my agent!' }is JavaScript syntax.
Python dictionaries require quoted keys.- return response.json({ message: 'Hello from my agent!' }) + return response.json({ "message": "Hello from my agent!" })content/SDKs/python/api-reference.mdx (1)
100-110: Missingawaitonrequest.data.email()Since
email()became async in v0.0.86, addawait.-email = request.data.email() +email = await request.data.email()
🧹 Nitpick comments (1)
content/SDKs/python/examples/index.mdx (1)
241-270: Variable shadowing (minor)
datais reassigned inside the"receive"branch, shadowing the earlierdatavariable from the"send"path.
Harmless but can confuse readers—consider renaming the inner variable.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
content/Changelog/sdk-py.mdx(1 hunks)content/SDKs/python/api-reference.mdx(4 hunks)content/SDKs/python/core-concepts.mdx(2 hunks)content/SDKs/python/examples/index.mdx(7 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/sdk.mdc:0-0
Timestamp: 2025-07-01T12:36:46.237Z
Learning: Applies to agent-docs/src/agents/**/*.ts : Use the storage APIs for persisting data
Learnt from: CR
PR: agentuity/docs#0
File: agent-docs/.cursor/rules/agent.mdc:0-0
Timestamp: 2025-07-01T12:36:36.319Z
Learning: Applies to agent-docs/**/src/agents/**/index.ts : Prefer loading types from the node modules package `@agentuity/sdk` in the node_modules folder
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Workers Builds: docs
🔇 Additional comments (5)
content/SDKs/python/examples/index.mdx (1)
14-27: Looks good – async usage is correctAll request-data accessors are properly awaited in this snippet.
No action needed.content/Changelog/sdk-py.mdx (1)
10-15: Release date appears out-of-order
v0.0.106is marked “Released: December 2024” but earlier entries (v0.0.100, etc.) are dated June 2025.
Please verify the year to keep chronological order.content/SDKs/python/api-reference.mdx (3)
233-246: Great – updated toawait request.data.json()Example correctly reflects the async breaking change.
268-285: Good – shows async accessor onDataResultDocs correctly use
await value.data.json().
948-951: Still using synchronous.textaccessorExample should now await
text().-text = request.data.text +text = await request.data.text()Likely an incorrect or invalid review comment.
content/Changelog/sdk-py.mdx
Outdated
|
|
||
| This page documents the release history of the [Agentuity Python SDK](https://github.com/agentuity/sdk-py). | ||
|
|
||
| ## v0.0.106 |
There was a problem hiding this comment.
there is no release for python with this version number
- Address jhaynie's feedback that v0.0.106 doesn't exist for Python SDK - Async breaking changes were already documented in v0.0.82 (April 30, 2025) - Keep all async pattern updates in examples and documentation - This PR now focuses on updating examples to match existing v0.0.82 requirements Co-Authored-By: Parteek Singh <parteek.singh24@gmail.com>
Co-Authored-By: Parteek Singh <parteek.singh24@gmail.com>
2 participants
Update Python SDK examples to use v0.0.82 async patterns
Summary
This PR updates Python SDK documentation examples to use the async/await patterns introduced in v0.0.82. The original task referenced v0.0.106, but this version doesn't exist for the Python SDK - the async breaking changes were actually introduced in v0.0.82 (April 30, 2025).
Key changes:
await request.data.json()instead ofrequest.data.json)The async transition (
request.data.json→await request.data.json()) was already documented in v0.0.82, but many examples throughout the documentation were still using the old synchronous patterns.Review & Testing Checklist for Human
await request.data.json()are syntactically correct Python async codeRecommended test plan: Build the documentation locally, navigate to the Python SDK examples and core concepts sections, and verify that all code examples render correctly and use consistent async patterns.
Diagram
%%{ init : { "theme" : "default" }}%% graph TB V082["content/Changelog/sdk-py.mdx<br/>v0.0.82 Entry (existing)"]:::context V106["content/Changelog/sdk-py.mdx<br/>v0.0.106 Entry (removed)"]:::major-edit PyExamples["content/SDKs/python/examples/index.mdx<br/>Python SDK Examples"]:::major-edit PyConcepts["content/SDKs/python/core-concepts.mdx<br/>Core Concepts"]:::minor-edit PyAPI["content/SDKs/python/api-reference.mdx<br/>API Reference"]:::minor-edit V082 -->|"already documented async changes"| V106 V082 -->|"provides correct async patterns"| PyExamples V082 -->|"provides correct async patterns"| PyConcepts V082 -->|"provides correct async patterns"| PyAPI subgraph Legend L1[Major Edit]:::major-edit L2[Minor Edit]:::minor-edit L3[Context/No Edit]:::context end classDef major-edit fill:#90EE90 classDef minor-edit fill:#87CEEB classDef context fill:#FFFFFFNotes
request.data.json→await request.data.json()