feat: Add streaming API support and documentation - #20
Merged
Conversation
Documents all eight environment variables the package and test suite actually read: the five required REST credentials, the two optional streaming settings, and the test log toggle. Contains placeholders only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Introduce streaming support and a more predictable REST client architecture for the Sportradar DataCore API.
Streaming API
streaming.pyprovidesHandballStreamClientandHandballStreamingAPIfor MQTT access grants and fixture or venue streams.stream_models.pydefines typed stream grants, messages, and publish results.stream_utils.pyhandles topic and payload decoding, including compressed payloads.streamextra keepspaho-mqttoptional and imports it lazily.REST configuration and lifecycle
DataCoreAPIperforms no network request.connect()remains available for explicit initialization, while the first endpoint call authenticates automatically.DataCoreSettingsprovides typed configuration andHandballAPI.from_env()supports environment variables plus optional.envloading.Generated client and codegen
src/datacore_client/._vendorimport indirection was removed to improve packaging and IDE/type-checker resolution.prepare_openapi_spec.pypreprocessing path.openapi-python-client==0.26.1is pinned for reproducibility.Documentation and tests
Verification
pytest test -q: 14 passed, 1 skipped becauseSTREAM_FIXTURE_IDis not set.The generated client remains build output and should only be changed through the codegen scripts.