Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(ws-tutorial): add a WebSocket tutorial #2245

Merged
merged 19 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
c3a0f9c
docs(ws-tutorial): add tutorial on how to use websockets
derkweijers Jul 13, 2024
383cf17
Merge branch 'master' into add_websocket_tutorial
derkweijers Jul 13, 2024
40cb884
docs(ws-tutorial): move example code to includable files
derkweijers Jul 13, 2024
0188221
Merge remote-tracking branch 'origin/add_websocket_tutorial' into add…
derkweijers Jul 13, 2024
f8a0864
docs(ws-tutorial): set max width to around 80
derkweijers Jul 13, 2024
be8c3e7
docs(ws-tutorial): change authentication method for websockets
derkweijers Jul 14, 2024
dc7f3d3
docs(ws-tutorial): typo fix
derkweijers Jul 14, 2024
bf8c9c3
Merge branch 'master' into add_websocket_tutorial
vytas7 Jul 14, 2024
337b065
docs(ws-tutorial): Do not generate coverage for the run command
derkweijers Jul 14, 2024
1ec1e56
docs(ws-tutorial): add explanation
derkweijers Jul 14, 2024
6863c12
docs(ws-tutorial): add tests for the example code
derkweijers Jul 14, 2024
fcffbd1
Merge remote-tracking branch 'origin/add_websocket_tutorial' into add…
derkweijers Jul 14, 2024
190316d
Merge branch 'master' into add_websocket_tutorial
vytas7 Jul 19, 2024
1c25f3d
chore(wslook): shorten comment lines in `client.py`
vytas7 Jul 24, 2024
3e712c9
style(wslook): shorten lines in `reports_client.py`
vytas7 Jul 24, 2024
b870931
docs(tutorial-ws): sand some rough edges, fix CI
vytas7 Jul 25, 2024
f88a803
docs(WS): add more interlinks to the tutorial
vytas7 Jul 25, 2024
284636c
chore: run tox -e wslook in CI
vytas7 Jul 25, 2024
4dcb8a6
docs(ws-tutorial): add coveragerc to the repo
derkweijers Jul 25, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ jobs:
- "towncrier"
- "look"
- "asgilook"
- "wslook"
- "check_vendored"
- "twine_check"
- "daphne"
Expand Down
4 changes: 4 additions & 0 deletions docs/api/websocket.rst
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,10 @@ by the framework.
app = falcon.asgi.App(middleware=SomeMiddleware())
app.add_route('/{account_id}/messages', SomeResource())

.. tip::
If you prefer to learn by doing, feel free to continue experimenting along
the lines of our :ref:`WebSocket tutorial <tutorial-ws>`!

Testing
-------

Expand Down
1 change: 1 addition & 0 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ User Guide
quickstart
tutorial
tutorial-asgi
tutorial-websockets
recipes/index
faq
4 changes: 4 additions & 0 deletions docs/user/tutorial-asgi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1033,6 +1033,10 @@ numerous ways:
:ref:`WebSockets <ws>`.
* ...And much more (patches welcome, as they say)!

.. tip::
If you want to add :ref:`WebSocket <ws>` support, please check out our
:ref:`WebSocket tutorial <tutorial-ws>` too!

Compared to the sync version, asynchronous code can at times be harder to
design and reason about. Should you run into any issues, our friendly community
is available to answer your questions and help you work through any sticky
Expand Down
Loading
Loading