Skip to content

Update README for Nimble and api_key authentication - #72

Merged
mahesh-bespoke merged 1 commit into
mainfrom
codex/readme-nimble
Sep 23, 2026
Merged

mahesh-bespoke merged 1 commit into
mainfrom
codex/readme-nimble

Conversation

@mahesh-bespoke

Copy link
Copy Markdown
Contributor

The README still used deprecated MiniCheck calls for its main quickstart and advanced examples. Replace those references with Nimble system_one examples covering synchronous/asynchronous usage, errors, retries, timeouts, and raw/streaming responses.

Also clarify api_key authentication, environment-variable and .env setup, and migration from auth_token in 0.4.0. Add the missing httpx import in the timeout example. This change only updates the README; it does not remove SDK resources or change runtime behavior.

Validation: all 18 Python snippets pass syntax validation, no MiniCheck/factcheck references remain in the README, and git diff --check passes.

@entelligence-ai-pr-reviews

Copy link
Copy Markdown

EntelligenceAI PR Summary

Updated the README to replace deprecated MiniCheck quickstart and advanced examples with Nimble system_one examples, including synchronous/asynchronous calls, error handling, retries, timeouts, raw responses, and streaming responses. Added clearer api_key authentication and environment/.env setup guidance, documented the auth_token migration for 0.4.0, and included the missing httpx import in the timeout example. No SDK resources or implementation code were changed.


Review Scorecard

Dimension Rating Basis
Code Quality ●●●●● 5/5 — Excellent no critical/significant findings — rated Excellent
Blast Radius Low changed symbols are referenced only within their own file(s); no high-impact surface touched, 1 file(s) / ~118 line(s) changed (size only — not a blast signal)
Merge Confidence ●●●●● 5/5 — Safe to Merge code quality 5/5 × Low blast radius

Safe to merge with a low blast radius; code quality rated Excellent (5/5): the review found nothing to flag.

Key Findings:

  • No critical or significant issues found
Evaluated against
  • 1/1 changed files reviewed
  • criteria: correctness, security & access control, robustness & error handling, concurrency & data integrity, repo conventions / steering docs
  • steering docs: none found in repo

@entelligence-ai-pr-reviews

Copy link
Copy Markdown

Walkthrough

Updates the README for the 0.4.0 client configuration and Nimble API workflow. The documentation now covers PyPI upgrades, authentication options, asynchronous usage, environment loading, migration from auth_token, and replaces MiniCheck examples with structured nimble.system_one examples across core usage and advanced response-handling scenarios.

Changes

Files

  • README.md

Updated 0.4.0 installation and configuration guidance, including PyPI upgrades, BESPOKE_API_KEY, explicit api_key usage, AsyncBespokeLabs, python-dotenv, and migration guidance from auth_token. Replaced MiniCheck examples with nimble.system_one examples using structured Noul results across standard, asynchronous, error-handling, retry, timeout, raw-response, and streaming sections, and added the missing httpx import.

@mahesh-bespoke
mahesh-bespoke merged commit 9d08184 into main Sep 23, 2026
5 checks passed
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.

1 participant