examples: add quickstart.py for basic OzAPI usage#35
Draft
kjankov wants to merge 1 commit into
Draft
Conversation
Adds a minimal runnable example showing how to instantiate the OzAPI client and dispatch a simple agent task. This lives in the examples/ directory (manually maintained, never overwritten by the generator). Co-Authored-By: Oz <oz-agent@warp.dev>
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
Adds a minimal, self-contained quickstart example to
examples/quickstart.py. It shows the two-line setup needed to instantiateOzAPIand dispatch a simple agent task — useful as a copy-paste starting point.Change
examples/quickstart.py— a runnable script (shebang:#!/usr/bin/env -S uv run python) that demonstratesclient.agent.run()with a short prompt and prints the resultingrun_id.examples/is a manually maintained directory that the generator never overwrites.Testing
Formatter (
ruff format --check+ruff check) and model tests (pytest tests/test_models.py) both pass:Screenshot
Conversation: http://localhost:8080/conversation/e1b9f234-e03e-4132-a38f-15a244159e54
Run: http://localhost:8082/runs/019edcb0-2ddd-7b71-ac0b-e11781e68779
This PR was generated with Oz.