idf-ci
A tool designed to streamline CI/CD for ESP-IDF projects, with support for both GitLab CI/CD and GitHub Actions.
Installation
pip install -U idf-ci
Key Features
-
Sensible Defaults
Easy setup with default settings for idf-build-apps and pytest-embedded.
-
Build Management
Build ESP-IDF apps for multiple targets (ESP32, ESP32-S2, ESP32-C3, etc.) with parallel builds and smart filtering based on changed files or test needs.
-
Test Management
Run
pytestwith ESP-IDF configs, including target-specific test discovery and marker filtering. -
GitLab CI/CD Integration
Full pipeline support with artifacts, S3 uploads, and auto-generated jobs for builds and tests.
-
GitHub Actions Integration
Generate test matrix from project settings.
Basic Usage
Initialize Configuration Files
# Create .idf_ci.toml with default idf-ci settings
idf-ci init
# Create .idf_build_apps.toml with default build settings
idf-ci build init
# Create pytest.ini with default test settings
idf-ci test init
Build Apps
# Build all apps
idf-ci build run
# Build apps for a specific target
idf-ci build run -t esp32
# Build only test-related apps
idf-ci build run --only-test-related
# Preview what would be built (dry run)
idf-ci build run --dry-run
Run Tests
We provide a pytest plugin that works with pytest-embedded to run tests with sensible defaults.
# Only collect tests that would run
pytest --collect-only
# Run tests for the esp32 target
pytest --target esp32
Documentation
For detailed usage and configuration options, please refer to the documentation.
1 maintainer
Release files for idf-ci 1.2.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_ci-1.2.2.tar.gz | 78.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| idf_ci-1.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 148.6 kB
Release files / idf_ci-1.2.2.tar.gz
| Download URL | idf_ci-1.2.2.tar.gz |
|---|---|
| Size | 78.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
75c47ca97c70faceab3f6ede890bbd74a85bf6f87e21489a0dac772198e63248
|
|
BLAKE2b-256 checksum How to use checksums |
7eba7efc490758153551feeb9692b57edef92547c23283b3ebf94714d4c3ada9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 21, 2026.
Transparency logRelease files / idf_ci-1.2.2-py3-none-any.whl
| Download URL | idf_ci-1.2.2-py3-none-any.whl |
|---|---|
| Size | 70.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1e56644efe07a2f56cb6ad192423f731eec3816672e42ec98c311b22fde57f6a
|
|
BLAKE2b-256 checksum How to use checksums |
58ab08a5c90a8a2d2a57e6e92dce8f26da8fdbd42106a99de44eb341597e60b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 21, 2026.
Transparency log
