Skip to content

examples: add quickstart.py for basic OzAPI usage - #35

Closed
kjankov wants to merge 4 commits into
mainfrom
oz/add-quickstart-example
Closed

examples: add quickstart.py for basic OzAPI usage#35
kjankov wants to merge 4 commits into
mainfrom
oz/add-quickstart-example

Conversation

@kjankov

@kjankov kjankov commented Jun 18, 2026

Copy link
Copy Markdown

Summary

Adds a minimal, self-contained quickstart example to examples/quickstart.py. It shows the two-line setup needed to instantiate OzAPI and dispatch a simple agent task — useful as a copy-paste starting point.

Change

  • New file: examples/quickstart.py — a runnable script (shebang: #!/usr/bin/env -S uv run python) that demonstrates client.agent.run() with a short prompt and prints the resulting run_id.
  • No production or generated code is touched; 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:

58 passed in 1.15s

Screenshot

Test run and quickstart.py

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.

dannyneira and others added 4 commits June 2, 2026 11:27
Co-authored-by: Oz <oz-agent@warp.dev>
* Add Oz SDK promotion workflow (#3)

* Add promote_oz_sdk workflow

Manual workflow_dispatch workflow that promotes SDK updates from this
staging repository to warpdotdev/oz-sdk-python by calling the shared
warpdotdev/warp-github-actions/.github/actions/promote_oz_sdk action.

Only the OZ_SDK_PRODUCTION_REPO_TOKEN secret is required. The production
repo name, release branch (stainless/release), and PR title
('Release SDK updates') are all managed by the shared action.

Co-Authored-By: Oz <oz-agent@warp.dev>

* Add Oz SDK promotion workflow

Co-Authored-By: Oz <oz-agent@warp.dev>

* Checkout full history for SDK promotion

Co-Authored-By: Oz <oz-agent@warp.dev>

* Update action name

---------

Co-authored-by: Oz <oz-agent@warp.dev>

* Bump the uv group across 1 directory with 2 updates (#4)

---
updated-dependencies:
- dependency-name: aiohttp
  dependency-version: 3.13.5
  dependency-type: direct:production
  dependency-group: uv
- dependency-name: idna
  dependency-version: '3.15'
  dependency-type: indirect
  dependency-group: uv
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Build SDK

Stainless-Generated-From: a80b3e8ef56463acbe762939a0ceaaf671b78a1b

* chore: restore promote workflow and changelog as sealed custom code

Stainless-Generated-From: c19340ba90218aca1b6f161cda3c8432341896b8

* chore: validate stlc 0.2.0 e2e after fork sync

Stainless-Generated-From: b84233a5d344c475bc4682f0b5f5aafe583a89f2

* fix: require aiohttp>=3.13.5 to resolve CVE-2026-22815

Durable replacement for the lockfile-only bump on production (03d6bc4):
a version floor in pyproject.toml survives stlc regeneration, whereas
raw uv.lock changes conflict on every rebuild.

* ci: restore test job (runs unit tests; mock tests remain skipped)

Same rationale as oz-sdk-typescript-staging: stlc omits the test job
without a hosted spec URL. 472 unit tests pass without prism.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Ben Navetta <ben@warp.dev>
Co-authored-by: Oz <oz-agent@warp.dev>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: stlc-bot <stlc-bot@users.noreply.github.com>
Co-authored-by: Ian Hodge <ian@warp.dev>
…CVE floors + test job (#32)

Adds memory_stores (current spec), seals idna/aiohttp CVE floors and the
CI test job, absorbs the stlc 0.2.0 fork-sync regen (formatted), drops
unlanded auto-memory types.

Co-authored-by: Ian Hodge <ian@warp.dev>
Co-authored-by: Oz <oz-agent@warp.dev>
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>
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.

4 participants