python docs update #43
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| Use the built-in `LoggingAgentListener` for easy debugging to stdout: | ||
|
|
||
| ```python | ||
| from auggie_sdk import Agent, LoggingAgentListener |
There was a problem hiding this comment.
Import Error: Incorrect class name
The import statement uses Agent but the correct class name is Auggie. This will cause an ImportError at runtime.
Current code:
from auggie_sdk import Agent, LoggingAgentListenerSuggested improvement:
from auggie_sdk import Auggie, LoggingAgentListenerThis same pattern is used correctly throughout the rest of the documentation (lines 24, 49, 91, 104, 128, 151, 161, 192, 223, 241).
| You can implement your own listener by subclassing `AgentListener`. This is useful for integrating with custom logging systems, UIs, or for programmatic reactions to agent events. | ||
|
|
||
| ```python | ||
| from auggie_sdk import Agent, AgentListener |
There was a problem hiding this comment.
Import Error: Incorrect class name
Same issue as line 46 - the import uses Agent instead of Auggie.
Current code:
from auggie_sdk import Agent, AgentListenerSuggested improvement:
from auggie_sdk import Auggie, AgentListener| @@ -0,0 +1,13 @@ | |||
| """Built-in Logger Example from user_guide.md""" | |||
|
|
|||
| from auggie_sdk import Agent, LoggingAgentListener | |||
There was a problem hiding this comment.
Import Error: Incorrect class name
The import uses Agent but should use Auggie. This will cause the script to fail when executed.
Current code:
from auggie_sdk import Agent, LoggingAgentListenerSuggested improvement:
from auggie_sdk import Auggie, LoggingAgentListener| @@ -0,0 +1,40 @@ | |||
| """Test if listener is being called""" | |||
|
|
|||
| from auggie_sdk import Agent, AgentListener | |||
There was a problem hiding this comment.
Import Error: Incorrect class name
The import uses Agent but should use Auggie.
Current code:
from auggie_sdk import Agent, AgentListenerSuggested improvement:
from auggie_sdk import Auggie, AgentListener
Add comprehensive documentation and examples for Python SDK
This PR enhances the Python SDK documentation by creating a structured learning path for users:
Key Changes
New user examples directory (
user_examples/) with 9 numbered tutorial examples (01-09) covering:Comprehensive user guide (
user_examples/user_guide.md) providing complete SDK documentation with API reference and usage patternsDetailed feature documentation in
docs/directory:Updated main README with improved organization, quick links to new resources, and workflow pattern examples
Test utilities including
run_all.shscript to execute all examples andtest_listener.pyfor testing event listenersImpact
Provides a clear, progressive learning path for Python SDK users from basic usage to advanced features, making it easier for developers to integrate the Augment agent into their workflows.
🤖 This description was generated automatically. Please react with 👍 if it's helpful or 👎 if it needs improvement.