Contributions Guide

Please use python 3.7+ for developing, but keep in mind that we need to support all ESP-IDF release versions.

ESP-IDF Version	Supported Python Versions
4.1	2.7, 3.4+
4.2	2.7, 3.4+
4.3	2.7, 3.4+
4.4	2.7, 3.4+
5.0	3.7+
5.1	3.7+
master	3.7+

Setup the Dev Environment

Create virtual environment
```
python -m venv venv
```
Activate the virtual environment
```
. ./venv/bin/activate
```
Install flit

We use flit to build the package and install the dependencies.
```
pip install flit
```
Install all dependencies

All dependencies would be installed, and our package idf-build-apps would be installed with editable mode.
```
flit install -s
```

Run Testing

We use pytest for testing.

pytest

Build Documentation

We use sphinx and autodoc for generating documentation and API references. Besides, we treat warnings as errors while building the documentation. Please fix them before your commits got merged.

cd docs && make html SPHINXOPTS="-W"

For documentation preview, you may use any browser you prefer. The executable has to be searchable in PATH. For example we’re using firefox here.

firefox _build/html/index.html