[SWE Destroyer] please fix the readme in scale-agentex-python to make it mor#263
Closed
danielmillerp wants to merge 1 commit intomainfrom
Closed
[SWE Destroyer] please fix the readme in scale-agentex-python to make it mor#263danielmillerp wants to merge 1 commit intomainfrom
danielmillerp wants to merge 1 commit intomainfrom
Conversation
Remove verbose advanced sections (logging, raw responses, streaming, custom HTTP config, null handling, versioning details) and keep only installation, basic usage, async usage, error handling, and requirements. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Comment on lines
33
to
48
| ## Async usage | ||
|
|
||
| Simply import `AsyncAgentex` instead of `Agentex` and use `await` with each API call: | ||
|
|
||
| ```python | ||
| import os | ||
| import asyncio | ||
| from agentex import AsyncAgentex | ||
|
|
||
| client = AsyncAgentex( | ||
| api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted | ||
| # defaults to "production". | ||
| environment="development", | ||
| api_key=os.environ.get("AGENTEX_SDK_API_KEY"), | ||
| ) | ||
|
|
||
|
|
||
| async def main() -> None: | ||
| tasks = await client.tasks.list() | ||
|
|
||
|
|
||
| asyncio.run(main()) | ||
| ``` | ||
|
|
||
| Functionality between the synchronous and asynchronous clients is otherwise identical. | ||
|
|
||
| ## Debugging | ||
|
|
||
| AgentEx provides built-in debugging support for **temporal projects** during local development. | ||
|
|
||
| ```bash | ||
| # Basic debugging | ||
| uv run agentex agents run --manifest manifest.yaml --debug-worker | ||
|
|
||
| # Wait for debugger to attach before starting | ||
| uv run agentex agents run --manifest manifest.yaml --debug-worker --wait-for-debugger | ||
|
|
||
| # Custom debug port | ||
| uv run agentex agents run --manifest manifest.yaml --debug-worker --debug-port 5679 | ||
| ``` | ||
|
|
||
| For **VS Code**, add this configuration to `.vscode/launch.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "name": "Attach to AgentEx Worker", | ||
| "type": "debugpy", | ||
| "request": "attach", | ||
| "connect": { "host": "localhost", "port": 5678 }, | ||
| "pathMappings": [{ "localRoot": "${workspaceFolder}", "remoteRoot": "." }], | ||
| "justMyCode": false, | ||
| "console": "integratedTerminal" | ||
| } | ||
| ``` | ||
|
|
||
| The debug server automatically finds an available port starting from 5678 and prints connection details when starting. | ||
|
|
||
| ### With aiohttp | ||
|
|
||
| By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend. | ||
|
|
||
| You can enable this by installing `aiohttp`: | ||
|
|
||
| ```sh | ||
| # install from PyPI | ||
| pip install agentex-sdk[aiohttp] | ||
| ``` | ||
|
|
||
| Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`: | ||
|
|
||
| ```python | ||
| import os | ||
| import asyncio | ||
| from agentex import DefaultAioHttpClient | ||
| from agentex import AsyncAgentex | ||
|
|
||
|
|
||
| async def main() -> None: | ||
| async with AsyncAgentex( | ||
| api_key=os.environ.get("AGENTEX_SDK_API_KEY"), # This is the default and can be omitted | ||
| http_client=DefaultAioHttpClient(), | ||
| ) as client: | ||
| tasks = await client.tasks.list() | ||
|
|
||
|
|
||
| asyncio.run(main()) | ||
| ``` |
There was a problem hiding this comment.
Debugging section was removed entirely
The original README contained a Debugging section with project-specific instructions for debugging temporal workers locally (--debug-worker, --wait-for-debugger, --debug-port) and a VS Code launch.json configuration. This information is non-trivial and hard to discover without documentation. Consider preserving at least a brief debugging section or linking to where this documentation lives (e.g., .cursor/rules/ or CLAUDE.md).
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 33-48
Comment:
**Debugging section was removed entirely**
The original README contained a Debugging section with project-specific instructions for debugging temporal workers locally (`--debug-worker`, `--wait-for-debugger`, `--debug-port`) and a VS Code `launch.json` configuration. This information is non-trivial and hard to discover without documentation. Consider preserving at least a brief debugging section or linking to where this documentation lives (e.g., `.cursor/rules/` or `CLAUDE.md`).
How can I resolve this? If you propose a fix, please make it concise.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated PR from SWE Destroyer agent. Prompt: please fix the readme in scale-agentex-python to make it more simple
Greptile Summary
This PR dramatically simplifies the README from ~397 lines to ~77 lines, retaining only the core sections (installation, usage, async usage, error handling, requirements, contributing). The simplification was generated by an automated SWE agent.
--debug-worker, VS Code launch config) — this is project-specific knowledge that is difficult for users to discover otherwisepip install agentex-sdk[aiohttp])environmentparameterConfidence Score: 3/5
README.md— review whether the removed debugging and advanced sections should be preserved or relocatedImportant Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[Original README ~397 lines] --> B{Simplification} B --> C[Kept: Installation] B --> D[Kept: Basic Usage] B --> E[Kept: Async Usage] B --> F[Kept: Error Handling - simplified] B --> G[Kept: Requirements & Contributing] B --> H[Removed: Debugging Section] B --> I[Removed: aiohttp Docs] B --> J[Removed: Error Code Table] B --> K[Removed: Retries/Timeouts Config] B --> L[Removed: Advanced Section] B --> M[Removed: Versioning & Types] C & D & E & F & G --> N[New README ~77 lines] H & I & J & K & L & M --> O[Content Lost] style H fill:#f96,stroke:#333 style O fill:#f96,stroke:#333Last reviewed commit: 4040f2d