idf-build-apps
idf-build-apps is a tool that helps users find and build ESP-IDF, and ESP8266 RTOS projects in a large scale.
What is an app?
A project using ESP-IDF SDK, or ESP8266 RTOS SDK typically contains:
- Build recipe in CMake or Make and the main component with app sources
- (Optional) One or more sdkconfig files
app is the abbreviation for application. An application is a set of binary files that is being built with the specified sdkconfig and the target chip. idf-build-apps could build one project into a number of applications according to the matrix of these two parameters.
Installation
pip install idf-build-apps
or pipx
pipx install idf-build-apps
Basic Usage
idf-build-apps is a python package that could be used as a library or a CLI tool.
As a CLI tool, it contains three sub-commands.
findto find the buildable applicationsbuildto build the found applicationscompletionsto activate autocompletions or print instructions for manual activation
For detailed explanation to all CLI options, you may run
idf-build-apps -h
idf-build-apps find -h
idf-build-apps build -h
idf-build-apps completions -h
As a library, you may check the API documentation for more information. Overall it provides
- Two functions,
find_appsandbuild_apps - Two classes,
CMakeAppandMakeApp
Quick CLI Example
To build ESP-IDF hello world example project with ESP32:
idf-build-apps build -p $IDF_PATH/examples/get-started/hello_world/ --target esp32
The binary files will be generated under $IDF_PATH/examples/get-started/hello_world/build directory.
Documentation
For detailed information, please refer to our documentation site!
Contributing
Thanks for your contribution! Please refer to our Contributing Guide
Release files for idf-build-apps 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| idf_build_apps-3.1.0.tar.gz | 45.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| idf_build_apps-3.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 98.8 kB
Release files / idf_build_apps-3.1.0.tar.gz
| Download URL | idf_build_apps-3.1.0.tar.gz |
|---|---|
| Size | 45.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
77740c3c691ec343e0c7bc1e01d0429d1ff134510a89ca6768ec4ed61cb09741
|
|
BLAKE2b-256 checksum How to use checksums |
b25f7d8820daeee0e922e2c7d52639c37b435d5d3665f919f61ed00b886519de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
Release files / idf_build_apps-3.1.0-py3-none-any.whl
| Download URL | idf_build_apps-3.1.0-py3-none-any.whl |
|---|---|
| Size | 53.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c5e1591a2c0507df6bfaf9a68997cac74752165fda2b10a87461756bfeb34764
|
|
BLAKE2b-256 checksum How to use checksums |
5652776c47ceda3aa45308195c17b60ea794a002896111fea4b0ec3e9dd7e80a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.34.2
|
Security for idf-build-apps 3.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
