docs: document pisama[auto] and pisama[agents] as recommended extras - #15
Merged
Conversation
Add a dedicated section with real usage examples (pulled from src/pisama/auto/__init__.py and src/pisama/agents/__init__.py) so the extras that replace the standalone pisama-auto / pisama-agent-sdk packages are documented as first-class install paths, not just a CLI comment.
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.
Summary
pisama[auto]andpisama[agents]as first-class, recommended install paths, with usage examples pulled from the real, already-merged source (src/pisama/auto/__init__.py'sinit(),src/pisama/agents/__init__.py's public hooks/check API).pisama-auto/pisama-agent-sdkpackages keep working and stay fully supported; the extras are the recommended path for new projects, not a replacement for existing installs.pisama[auto]CLI comment for consistency with the new section.Docs only. No code, dependency, or version changes.
Test plan
init()signature andpisama.agentspublic API against currentsrc/pisama/auto/__init__.pyandsrc/pisama/agents/__init__.py