docs: registry storefront README + v1.10.1#49
Merged
Conversation
Apply the shared registry-storefront formula from the PHP SDK: - hero line (oil/gas/LNG/carbon/fuels in under 60 seconds) + audience line + 2M+ requests/month - shields.io pypi/v badge, nav line with utm_source=python-sdk and quick-start jump link - "What can you get?" 10-commodity table after the hero - "The whole OilPriceAPI toolbox" cross-SDK table before Testing - bump version to 1.10.1 (version.py + pyproject.toml) so PyPI re-renders the README Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThis PR widens the ChangesConfidence Field and Version Update
README Storefront Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Live contract tests (first run with a real key) caught the API sending confidence: 0.65 (float) where the model required a string label — now Union[str, float]. Also links the interactive Swagger explorer and raw OpenAPI spec from the README (they existed, unadvertised). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CHANGELOG.md (1)
10-15: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winChangelog entry omits the confidence type fix.
Entry states "docs: registry storefront README — hero, "What can you get?" commodity table, and cross-SDK toolbox table so the PyPI page matches the other OilPriceAPI SDKs. No code changes." but this same release also widens
MarketBriefForecast.confidencetoUnion[str, float]— a functional/contract fix, not just docs. Consider adding a "Fixed" note for the confidence field so users relying on the changelog aren't misled about code changes in 1.10.1.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CHANGELOG.md` around lines 10 - 15, The 1.10.1 changelog entry currently only mentions the README/docs update and omits the functional contract change. Update the release note in CHANGELOG.md to also include a “Fixed” item for the `MarketBriefForecast.confidence` type widening to `Union[str, float]`, so the entry reflects both the docs work and the code change.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@CHANGELOG.md`:
- Around line 10-15: The 1.10.1 changelog entry currently only mentions the
README/docs update and omits the functional contract change. Update the release
note in CHANGELOG.md to also include a “Fixed” item for the
`MarketBriefForecast.confidence` type widening to `Union[str, float]`, so the
entry reflects both the docs work and the code change.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e639e8d2-6c76-44e4-a291-091f71bb2d33
📒 Files selected for processing (6)
CHANGELOG.mdREADME.mdoilpriceapi/models.pyoilpriceapi/version.pypyproject.tomltests/unit/test_subscriptions_resource.py
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
Applies the shared "registry storefront" marketing formula (shipped in the PHP SDK README) to the Python SDK, and bumps the version so PyPI re-renders the README from the new release.
pypi/v; kept downloads, pyversions, tests, coverage, licenseutm_source=python-sdk) · docs · pricing · jump link to the existing Quick Start anchoroilpriceapi/version.py+pyproject.toml(verified in sync) + CHANGELOG entry — docs-only release so the PyPI page updatesAll other content (quick starts, Beyond Oil, resources, streaming, error handling) preserved. Removed one duplicated mini "Quick start: pip install" block that repeated the Installation section verbatim.
Verification
www.oilpriceapi.com/auth/signup)version.py==pyproject.toml== 1.10.1, CHANGELOG contains 1.10.1Do NOT merge without review.
🤖 Generated with Claude Code
Summary by CodeRabbit
Bug Fixes
Documentation
Tests
Chores