-
Notifications
You must be signed in to change notification settings - Fork 171
[examples]: enhance example with docs, pytest setup, and standalone test server #902
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
Open
gabsuren
wants to merge
1
commit into
espressif:master
Choose a base branch
from
gabsuren:docs/readme_update
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
|
2ef1538
to
8e0f8b0
Compare
8e0f8b0
to
43ae4c5
Compare
43ae4c5
to
e21d306
Compare
e21d306
to
d2e1994
Compare
d2e1994
to
0df1f91
Compare
85da078
to
38e70fb
Compare
38e70fb
to
a8e33b1
Compare
a8e33b1
to
9da66bf
Compare
9da66bf
to
00e0305
Compare
00e0305
to
4d4d4ed
Compare
4d4d4ed
to
439f139
Compare
…ne test server - Add comprehensive README with TOC and quick start - Add pytest setup and certificate generation scripts - Add standalone WebSocket test server with TLS support - Add troubleshooting and multiple testing approaches
439f139
to
6f87c26
Compare
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.
Description
This PR enhances the WebSocket client example documentation and testing infrastructure to improve user experience and development workflow.
The changes add comprehensive documentation, automated testing setup, certificate generation tools, and a standalone WebSocket test server to make the example more accessible and easier to use.
Key Improvements:
Documentation Enhancements:
Added Table of Contents for better navigation
Added Quick Start section with step-by-step instructions
Enhanced certificate generation documentation with multiple options
Improved SDK configuration explanations with pre-configured options
New Features:
Standalone WebSocket server with TLS and mutual authentication support
Automated certificate generation with proper directory structure
Multiple testing approaches (pytest, standalone server, Flask alternative)
Clear usage examples and command-line options
Testing Infrastructure:
Added pytest dependencies and execution instructions
Created standalone WebSocket test server (websocket_server.py) with CLI interface
Separated server code from pytest to eliminate duplication
Added certificate generation script (generate_certs.sh) for automated setup
Checklist
🚨 This PR does not introduce breaking changes.
✅ All CI checks (GH Actions) pass.
✅ Documentation is updated as needed.
✅ Tests are updated or added as necessary.
✅ Code is well-commented, especially in complex areas.
✅ Git history is clean — commits are squashed to the minimum necessary.