Improve gridstatusio agent-legibility (README call-contract + PyPI metadata + py.typed) - #110
Merged
Conversation
Shiggiddie
changed the title
gridstatusio agent-legible (README call-contract + PyPI metadata + py.typed)gridstatusio agent-legibility (README call-contract + PyPI metadata + py.typed)
kmax12
reviewed
Jun 12, 2026
| @@ -1,5 +1,18 @@ | |||
| # Changelog | |||
|
|
|||
| ## 0.16.0 - June 11, 2026 | |||
Collaborator
There was a problem hiding this comment.
let's remove the date on the changelog from this PR. we will add it in the PR the cuts the release
Contributor
Author
There was a problem hiding this comment.
Done — removed the date in c116d46. It'll be set in the release-cutting PR.
kmax12
self-requested a review
June 19, 2026 14:33
|
|
||
| * **NOTE**: the Grid Status API has a 500,000 rows per month limit on the free plan. This limit is _very_ easy to exceed when querying data, especially real time prices. | ||
| * Make sure to add `limit` to all of your `get_dataset` calls to avoid quickly exceeding the limit. | ||
| > **⚠️ Row limit:** the free plan allows 500,000 rows per month, which is *very* easy to exceed — especially with real-time prices. **Add `limit` to every `get_dataset` call** and use bounded `start`/`end` windows. Check current limits and usage with `client.get_api_usage()`. |
Contributor
There was a problem hiding this comment.
Do we need to mention an exact number or can we say "allows a limited number of rows per month"
Contributor
|
@Shiggiddie Are we going to merge this to get a new release or should I go ahead with #116 ? |
Collaborator
|
@WillKoehrsen go ahead with your PR. im going to return to this to tweak readme more |
kmax12
force-pushed
the
ws0-agent-legible-package
branch
2 times, most recently
from
July 8, 2026 04:21
e54915b to
da65d17
Compare
kmax12
force-pushed
the
ws0-agent-legible-package
branch
from
July 8, 2026 05:02
b067490 to
ccc7ef0
Compare
kmax12
approved these changes
Jul 17, 2026
kmax12
left a comment
kmax12
left a comment
Collaborator
There was a problem hiding this comment.
made some edits. LGTM now
WillKoehrsen
approved these changes
Jul 17, 2026
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
3 participants
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.
Improve
gridstatusioagent-legibiltiyREADME — restructured as a "call contract"
tz=), thelimitdiscipline + free-tier row caps, cursor pagination, and server-side filtering/resampling.pyproject.toml— PyPI discoverabilitydescription.keywords.kmax12/gridstatusio→gridstatus/gridstatusio, and addedHomepage/Documentation/Data Catalog/Changes.Typing
gridstatusio/py.typed(PEP 561) so downstream type-checkers consume the package's types. Confirmed present in the built wheel.Verification
uv build --wheelsucceeds;METADATAreflects the new Summary/classifiers/URLs/keywords;gridstatusio/py.typedships in the wheel.Notes
pyprojectwas already at 0.16.0 butversion.py/PyPI lagged at 0.15.1; syncedversion.pyand added a CHANGELOG entry covering this release (return formats, Python 3.14, brotli) plus these changes. Publishing is triggered by a GitHub Release, not by merging this PR.tool.uv.dev-dependenciesdeprecated) left untouched.