Skip to content

docs: stop telling README readers that region is mandatory - #87

Merged
ClayMav merged 2 commits into
mainfrom
docs/fix-readme
Oct 28, 2026
Merged

ClayMav merged 2 commits into
mainfrom
docs/fix-readme

Conversation

@ClayMav

@ClayMav ClayMav commented Oct 28, 2026

Copy link
Copy Markdown
Member

Summary

The README still said region is mandatory and that sessions without one land in aws-us-west-2. That contradicts its own "Basic usage" section, and since 0.28.0 the driver leaves an omitted region out of the request so the API applies the organization's default. It also had the Store defaults wrong, and it called apilevel/threadsafety/paramstyle module-level globals when wherobots.db doesn't export them.

This PR:

  • Makes region optional with the org default and removes the stale us-west-2 warning.
  • Corrects Store: format is required, single defaults to False, and generate_presigned_url requires single=True.
  • Says the PEP 249 globals live in wherobots.db.driver. Docs only, no code change.
  • Fixes the "PEP-2049" typo.

Related Issues

None.


Requester Checklist

Complete these before marking Ready for Review

  • I have self-reviewed my own code
  • I have added/updated tests that prove my fix/feature works (docs only)
  • I have included visual proof (screenshot, video, or test output) if applicable
  • All CI checks are passing
  • PR size is S/M, OR I have justified the size and added a walkthrough
  • I have updated documentation if needed

Visual Proof

Ran these with uv run python -c ... on this branch:

  • hasattr(wherobots.db, "apilevel") is False. from wherobots.db.driver import apilevel, threadsafety, paramstyle gives 2.0 1 pyformat.
  • dataclasses.fields(Store): format has no default, single=False, generate_presigned_url=False, options=None.
  • Store.for_download() gives format=PARQUET, single=True, generate_presigned_url=True.
  • Store(format=StorageFormat.CSV, generate_presigned_url=True) raises ValueError: Presigned URL can only be generated when single=True.
  • connect() (driver.py) sets params={"region": region_name, ...}, and requests omits a None param, so an omitted region is never sent.

pre-commit run --files README.md passes (end-of-file, trailing whitespace, codespell).

An independent adversarial agent review found no false claims. Its one nit, the presigned URL needing single=True, is fixed here. It also flagged the Store docstring in models.py, which still says format defaults to parquet. That is left for a separate change, along with the pyproject.toml Homepage/Tracker URLs.

Size Justification (if L/XL)

N/A


Reviewer Checklist

If these are not met, close the tab — this PR is not ready for review

  • Requester checklist above is complete
  • All CI checks are passing
  • Tests adequately cover the changes

Changes made by Claude Opus 5.5 via Claude Code.

@ClayMav

ClayMav commented Oct 28, 2026

Copy link
Copy Markdown
Member Author

@salty-hambot review

@salty-hambot salty-hambot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed by Salty Hambot 🤖🧂 at cb219bf

No issues found.
💰 $0.0484 · 31.8k in / 942 out tokens · ⏱️ 8.2s · us.openai.gpt-6-sol high, prompt coverage-v1
💬 To request a re-review, comment @salty-hambot review

@ClayMav
ClayMav marked this pull request as ready for review October 28, 2026 21:54
@ClayMav
ClayMav requested a review from a team as a code owner October 28, 2026 21:54
@ClayMav
ClayMav merged commit 734ecb6 into main Oct 28, 2026
7 of 12 checks passed
@ClayMav
ClayMav deleted the docs/fix-readme branch October 28, 2026 23:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants