docs: sync README + examples to v0.1.1 typed-model field names#7
Merged
Conversation
v0.1.0's README and examples used the field names I'd guessed for the typed models. v0.1.1 (PR #6) rewrote the models with the real field names the API returns. The README + two example scripts still referenced the old names — anyone copy-pasting the code would get AttributeError. Field-name fixes (applied to README + examples/quickstart.py + examples/migrate-from-kevinzg.py): page.name → page.title page.likes → page.likes_count page.followers → page.followers_count page.about → page.bio page.verified → dropped (no equivalent in real API response) profile.followers → profile.followers_count profile.posts_count → profile.media_count profile.full_name and profile.is_verified were already correct. Verified locally: ruff check . → All checks passed! ruff format --check . → 17 files already formatted pytest → 33 passed, 80% coverage No code changes to the SDK — pure docs / example sync.
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.
Why
v0.1.1 (#6) rewrote `PageInfo`, `GroupInfo`, and `ProfileInfo` with the real field names the API returns. The README and two example scripts still referenced the v0.1.0 field names — anyone copy-pasting the quickstart code would hit `AttributeError`.
Mapping
`profile.full_name`, `profile.is_verified`, and `profile.is_private` were already correct in v0.1.0 — kept as-is.
Files touched
What does NOT change
Verification
```
ruff check . → All checks passed!
ruff format --check . → 17 files already formatted
pytest → 33 passed
```