📝 More explicitly explain dependencies in websockets doc page #9930
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
|
📝 Docs preview for commit 9944f99 at: https://64bc7cd6a11600468968067f--fastapi.netlify.app |
9944f99 to
9df46e2
Compare
|
📝 Docs preview for commit 9df46e2 at: https://64be82424e1061008bd78812--fastapi.netlify.app |
codespearhead
approved these changes
Apr 2, 2024
|
📝 Docs preview for commit 2e1bf33 at: https://ceb977ba.fastapitiangolo.pages.dev Modified Pages |
YuriiMotov
reviewed
Jul 20, 2025
There was a problem hiding this comment.
The text of this section was updated since the time this PR was opened.
But it still looks a bit incomplete: it's said that we need to create environment and install websockets, but it's said nothing about installing FastAPI itself.
How about the following?
## Install `uvicorn` and `websockets`
Make sure you create a [virtual environment](../virtual-environments.md){.internal-link target=_blank}, activate it, and install `fastapi`, `uvicorn` and `websockets`:
<div class="termy">
```console
$ pip install fastapi uvicorn websockets
---> 100%
```
</div>
/// tip
If you install FastAPI using `pip install fastapi[standard]`, you don't need to install websockets separately - it will be installed by default.
///
/// note
You will not interact with `websockets` package directly, it's required for Uvicorn to handle the websocket protocol.
///
|
As this PR has been waiting for the original user for a while but seems to be inactive, it's now going to be closed. But if there's anyone interested, feel free to create a new PR. |
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.
The note at the top of the websockets doc page implies FastAPI has an implicit dependency on the
websocketspackage. As a result, I mistakenly spent quite a bit of time reading thewebsocketsdocs, thinking it would help me work with thefastapi.websocketfunctionality.FastAPI itself instead relies solely on the Starlette WebSockets implementation, which has an entirely different API.
This MR attempts to update the documentation to make it more explicit WHY
websocketsis required. It's not a fastapi dependency by any means, but a uvicorn dependency (and the tutorial makes use of uvicorn)