fix: add missing requirements_realtime.txt referenced throughout install docs#28
Open
mvanhorn wants to merge 1 commit into
Open
Conversation
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.
Summary
Adds the
requirements_realtime.txtfile that the install docs reference but that was missing from the tree, and pins the dependencies the realtime modules actually import:aiohttpplusaiohttp-cors(imported by the HTTP API and monitor dashboard), andwebsocketscapped below the version that changed the server-handler signature the push service relies on.Why this matters
docs/INSTALL.mdpoints atrequirements_realtime.txtin five places, but the file did not exist, so a fresh install following the docs could not set up the realtime stack. Beyond restoring the file,aiohttpalone does not pull inaiohttp_cors, and an unconstrainedwebsocketsresolves to a major version whoseservehandler signature breaks the existing two-argumentRealtimeDataPushService.handle_client, so both are constrained to what the code actually runs against. Reported in #26.Testing
Added a test that asserts the requirements file exists and lists the imports the realtime modules need; it passes locally.
Closes #26