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.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| idf_build_apps-3.0.2.tar.gz | 97.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| idf_build_apps-3.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 150.1 kB
Release files / idf_build_apps-3.0.2.tar.gz
| Download URL | idf_build_apps-3.0.2.tar.gz |
|---|---|
| Size | 97.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
395bfc2934e000cfc5d7392134228f691f0cdfbb3068fbba30a5e08564229d29
|
|
BLAKE2b-256 checksum How to use checksums |
3d62bf1cd3f50904f751cc2e1dfe3bb6951faf0486c0aaf7aa42eb84e7ed5c93
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.33.1
|
Release files / idf_build_apps-3.0.2-py3-none-any.whl
| Download URL | idf_build_apps-3.0.2-py3-none-any.whl |
|---|---|
| Size | 52.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2c2656d4f6bcd73d5f08bffc49a3b965cb1c7115134180e11f3efcd3d3888bf8
|
|
BLAKE2b-256 checksum How to use checksums |
4b6e513546a4f74e6e47137ea357336999d848b1f59831343dd45af065649b2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.33.1
|
