Implement pagination helpers with stream methods for seamless data access#31
Merged
Implement pagination helpers with stream methods for seamless data access#31
Conversation
…cess Co-authored-by: godely <3101049+godely@users.noreply.github.com>
Co-authored-by: godely <3101049+godely@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Task 7: Implement pagination helpers
Implement pagination helpers with stream methods for seamless data access
Jun 30, 2025
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
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.
This PR implements high-level iterators and stream methods that automatically follow
next_tokento yield all items transparently, as requested in Task 7 of the Milestone 2 roadmap.🚀 New Features
Seamless Pagination with
.stream()MethodsAll paginated endpoints now support automatic streaming without manual pagination logic:
Supported Endpoints
All major paginated endpoints now have
.stream()methods:client.daily_sleep.stream()- Stream sleep dataclient.daily_activity.stream()- Stream activity dataclient.heartrate.stream()- Stream heart rate samplesclient.session.stream()- Stream workout/session dataclient.daily_readiness.stream()- Stream readiness scores🔧 Implementation Details
oura_api_client.utils.pagination.stream_paginated_data()for reusable pagination logic_stream_documents()method for consistent pagination across all endpointsIterator[ModelType]return types📚 Documentation Updates
🧪 Testing
📋 Benefits
for item in endpoint.stream():syntaxFixes #14.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.