Registry / devops / idf-component-manager

idf-component-manager

JSON →
library3.1.0pypypi✓ verified 23d ago

The IDF Component Manager is a Python-based tool by Espressif that integrates with the ESP-IDF build system to download and manage components from the ESP Component Registry or Git repositories. It ensures that correct versions of all project dependencies are present during a CMake run. This library, currently at version 3.0.1, receives updates frequently, often tied to major ESP-IDF releases, with major version bumps indicating significant breaking changes.

pip install idf-component-manager
INSTALL
IMPORT
SIG · IDF-COMPONENT-MANA
I
idf-component-manager
devopspythonv3.1.0
Install
6.2s avg
Import
Disk
48MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v3.1.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 51.5MB
glibc
py 3.103.95 runs
installs and imports cleanly · install 6.2s · import 0.000s · 51MB
48MB installed
● package 48MB
Code
Verified usage

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

idf_component_manager
python -m idf_component_manager <command>
The library is primarily used as a command-line tool via the 'idf.py' wrapper or direct module execution, rather than as a Python library imported into user scripts for its core component management functionality.
compote
compote <command>
The 'compote' CLI provides advanced workflows for the Component Manager, including publishing components.

The IDF Component Manager primarily operates through the `idf.py` command-line tool. This example demonstrates how to add a component dependency to your project, which automatically creates or updates the `idf_component.yml` manifest file and manages dependencies during the build process.

# Navigate to your ESP-IDF project directory # Add a dependency to your main component (e.g., 'example/cmp') idf.py add-dependency example/cmp # Or create a manifest file and then build # idf.py create-manifest # Edit main/idf_component.yml to add dependencies like: # dependencies: # espressif/json: '^1.0.0' # Then, reconfigure and build your project: # idf.py reconfigure # idf.py build
idf-component-manager --version
Debug
Known issues
breakingVersion 3.0.0 dropped support for Python versions older than 3.10. Projects using `idf-component-manager` 3.x.x must use Python 3.10 or newer.
fix
Upgrade Python to version 3.10 or later, or pin `idf-component-manager` to a version <3.0.0.
affects: >=3.0.0
breakingVersion 3.0.0 introduced breaking changes in ESP-IDF integration, requiring ESP-IDF version 6.0.0 or later. Older ESP-IDF versions are no longer supported by `idf-component-manager` v3.x.x.
fix
Upgrade your ESP-IDF installation to v6.0.0 or newer, or pin `idf-component-manager` to a version <3.0.0.
affects: >=3.0.0
deprecatedEnvironment variables `IDF_COMPONENT_KNOWN_TARGETS` and `IDF_COMPONENT_MANAGER_KNOWN_TARGETS` were removed in version 3.0.0.
fix
Remove these environment variables from your build environment or scripts.
affects: >=3.0.0
gotchaThe component manager is not fully supported in 'IDF as a Lib' projects (projects that use `IDF`'s `tools/cmake/idf_as_lib.cmake`). As of March 2024, it's primarily designed for projects using `IDF`'s `tools/cmake/project.cmake`.
fix
Consider restructuring your project to use the standard ESP-IDF project structure or manually manage components in 'IDF as a Lib' projects.
affects: All versions
gotchaIf you manually add or modify an `idf_component.yml` manifest file, you need to run `idf.py reconfigure` to ensure CMake picks up the changes and the component manager processes the new dependencies.
fix
Always run `idf.py reconfigure` after making manual changes to `idf_component.yml`.
affects: All versions
Upgrade
Version history
3.1.0latest on PyPI · released Jul 14, 2026
Audit
Dependencies
esp-idfrequiredCore functionality is tightly integrated with the ESP-IDF build system and requires a compatible version.
pythonrequiredRequires Python 3.10 or newer (for v3.x+).
Agent activity
14 hits · last 30 days
node
12
OpenAI (training)
1
Resources
idf-component-manager — pip install idf-component-manager · libregistry