idf-ci

library1.1.0pypypi✓ verified 80d ago

Python library for CI/CD of ESP-IDF projects. Currently at version 1.1.0, released with a monthly cadence. Provides tools to automate building, testing, and deployment for ESP-IDF firmware.

devops testing workflow

pip install idf-ci

github ↗package ↗docs ↗changelog ↗

INSTALL

IMPORT

SIG · IDF-CI

idf-ci

devopspythonv1.1.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

CiSettings

✓ from idf_ci import CiSettings

✗ from idf_ci import IDFBuild

get_ci_settings

✓ from idf_ci import get_ci_settings

get_pytest_cases

✓ from idf_ci import get_pytest_cases

Build an ESP-IDF project and flash it to a device.

from idf_ci import IDFBuild, Flash import os # Build the project builder = IDFBuild(project_dir='./my_project', build_dir='./build') builder.run() # Flash the firmware flash = Flash(port=os.environ.get('ESP_PORT', '/dev/ttyUSB0')) flash.run(binary='./build/app.bin')

Debug

Known issues

gotchaThe library requires the ESP-IDF environment to be sourced prior to use. Running commands without sourcing will result in missing toolchain errors.

fix

Run `. $HOME/esp/esp-idf/export.sh` before executing scripts.

affects: all

breakingIn version 1.0.0, the `IDFBuild` class was renamed from `Builder`. Existing code using `Builder` will break.

fix

Replace imports from `idf_ci.Builder` to `idf_ci.IDFBuild`.

affects: <1.0.0

gotchaThe `Flash` class only supports serial ports; it does not support JTAG or other interfaces.

fix

Ensure you are using a UART serial connection. For JTAG, use esptool.py directly.

affects: all

Upgrade

Version history

1.1.0latest on PyPI · released Apr 16, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

26 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/espressif/idf-ci ↗

packagehttps://pypi.org/project/idf-ci/ ↗

docshttps://docs.espressif.com/projects/idf-ci ↗

changeloghttps://github.com/espressif/idf-ci/blob/master/CHANGELOG.md ↗