Skip to content

Commit 8e0f8b0

Browse files
committed
docs(websocket): add pytest dependencies and execution instructions
1 parent 6f6237a commit 8e0f8b0

File tree

1 file changed

+25
-1
lines changed
  • components/esp_websocket_client/examples/target

1 file changed

+25
-1
lines changed

components/esp_websocket_client/examples/target/README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,31 @@ idf.py -p PORT flash monitor
7373

7474
(To exit the serial monitor, type ``Ctrl-]``.)
7575

76-
See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
76+
See the [ESP-IDF Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html) for full steps to configure and use ESP-IDF to build projects.
77+
78+
## Testing with pytest
79+
80+
### Install Dependencies
81+
82+
Before running the pytest tests, you need to install the required Python packages:
83+
84+
```
85+
pip install -r esp-protocols/ci/requirements.txt
86+
```
87+
88+
### Run pytest
89+
90+
After installing the dependencies, you can run the pytest tests:
91+
92+
Run all tests in current directory:
93+
```
94+
pytest .
95+
```
96+
97+
Run specific test file:
98+
```
99+
pytest pytest_websocket.py
100+
```
77101

78102
## Example Output
79103

0 commit comments

Comments
 (0)