Skip to content

Add examples/ directory with runnable scripts #17

@splch

Description

@splch

Peer SDKs (stripe-python, openai-python, twilio-python) all ship an examples/ directory with standalone, runnable scripts. These serve as integration tests, documentation, and onboarding material simultaneously.

The README has inline code snippets, but no copy-pasteable runnable scripts that a new user can execute end-to-end.

Suggested examples:

  • List backends (unauthenticated)
  • Submit a circuit job and poll for results
  • Downstream SDK integration
  • Async usage
  • Session management
  • Pagination
  • Native gate matrices

Context: identified during open-source readiness audit against peer SDK standards.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions