Skip to content

docs: improve SDK guides and examples - #7

Open
varin-nair-factory wants to merge 1 commit into
mainfrom
user/python-sdk-docs
Open

docs: improve SDK guides and examples#7
varin-nair-factory wants to merge 1 commit into
mainfrom
user/python-sdk-docs

Conversation

@varin-nair-factory

Copy link
Copy Markdown
Contributor

Summary

  • reorganize the README around common SDK tasks
  • align Python guidance with the TypeScript SDK for sessions, models, Auto Router, BYOK, streaming, inputs, permissions, tools, skills, and MCP
  • document TypeScript-only capabilities instead of implying unsupported parity
  • add concise runnable examples for each supported workflow

Validation

  • uv run --group dev python -m pytest -q (1,252 passed, 8 skipped)
  • DROID_LIVE_TESTS=1 uv run --group dev python -m pytest tests/test_live_droid_exec.py -v (8 passed)
  • executed every runnable example against the authenticated Droid CLI
  • uv run mypy --strict src/ examples/
  • uv run ruff check src/ tests/ examples/
  • uv run ruff format --check src/ tests/ examples/
  • compiled all README Python snippets and checked local links
  • uv build

Document the Python SDK around common workflows and add concise runnable examples for sessions, models, attachments, permissions, and structured output.

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
@varin-nair-factory varin-nair-factory self-assigned this Aug 10, 2026
@varin-nair-factory
varin-nair-factory marked this pull request as ready for review August 10, 2026 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants