From 87514f4a2b8cf05cdb5150d8b67c66f05436d69e Mon Sep 17 00:00:00 2001 From: KonstantinKondrashov Date: Mon, 17 Jan 2022 20:37:18 +0800 Subject: [PATCH] examples: Adds a note on how to meet requirements to run the example_test.py export PYTHONPATH="$IDF_PATH/tools:$IDF_PATH/tools/ci/python_packages" python -m pip install -r $IDF_PATH/tools/ci/python_packages/ttfw_idf/requirements.txt It helps to fix the ModuleNotFoundError issue with ttfw_idf and tiny_test_fw modules. Closes https://github.com/espressif/esp-idf/issues/7815 --- examples/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/examples/README.md b/examples/README.md index 240e270384..2dc9623b8d 100644 --- a/examples/README.md +++ b/examples/README.md @@ -30,6 +30,17 @@ Building an example is the same as building any other project: * `idf.py build` to build the example. * Follow the printed instructions to flash, or run `idf.py -p PORT flash`. +## Running Test Python Script + +Some of the examples have `..._test.py` scripts that are used to test that the example works as expected. These scripts run automatically in the internal test queue. They are not intended to be run by ESP-IDF users but sometimes you may want to run them locally. The following requirements must be met in the IDF python virtual environment. + +* ttfw needs to be in the `PYTHONPATH`. Add it like this: `export PYTHONPATH=$PYTHONPATH:$IDF_PATH/tools/ci/python_packages` +* Install all requirements from `tools/ci/python_packages/ttfw_idf/requirements.txt`: `python -m pip install -r $IDF_PATH/tools/ci/python_packages/ttfw_idf/requirements.txt` + +These commands help solve the issue with `ModuleNotFoundError: No module named 'ttfw_idf'` and `ModuleNotFoundError: No module named 'tiny_test_fw'`. + +Some examples might fail due to other missing packages. You might need to install them manually: `pip install websocket`. + # Copying Examples Each example is a standalone project. The examples *do not have to be inside the esp-idf directory*. You can copy an example directory to anywhere on your computer in order to make a copy that you can modify and work with.