falconry / falcon

The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.
https://falcon.readthedocs.io/en/stable/
Apache License 2.0
9.53k stars 945 forks source link

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

Closed derkweijers closed 3 months ago

derkweijers commented 4 months ago

Summary of Changes

Add a tutorial on how to work with websockets in a Falcon app. This is to be read as a quickstart, linking to the reference page for more info.

Related Issues

Closes #2240

Pull Request Checklist

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it will save you a few review cycles!

If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

PR template inspired by the attrs project.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 36.17%. Comparing base (89b5fb0) to head (4dcb8a6).

:exclamation: There is a different number of reports uploaded between BASE (89b5fb0) and HEAD (4dcb8a6). Click for more details.

HEAD has 1 upload less than BASE | Flag | BASE (89b5fb0) | HEAD (4dcb8a6) | |------|------|------| ||2|1|
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2245 +/- ## ============================================ - Coverage 100.00% 36.17% -63.83% ============================================ Files 63 63 Lines 6852 6852 Branches 1260 1260 ============================================ - Hits 6852 2479 -4373 - Misses 0 4315 +4315 - Partials 0 58 +58 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

derkweijers commented 3 months ago

Ah, it seems we forgot to commit wslook/.coveragerc. Do you maybe have the file lying anywhere around @derkweijers?

Yes! Added it to the repo.

CaselIT commented 3 months ago

I guess I've arrived too late with the review, @vytas7 you mentioned you wanted to cleanup something else, maybe you can incorporate the suggestions?

@derkweijers thanks for the great tutorial, and for participating in the sprint!

vytas7 commented 3 months ago

@CaselIT yeah, thanks! Just add these suggestions to #2255