---
id: esp-idf-kconfig
version: "3.12.0"
license: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for… (full text in the JSON record)
license_treatment: permissive
maintenance: active
---

# esp-idf-kconfig — Kconfig tooling for esp-idf

License: permissive · Maintenance: active · Downloads: 1.4M/mo

## What it is and what it does

esp-idf-kconfig is a configuration management tool for Espressif's ESP-IDF embedded development framework. It parses and validates project settings using the kconfig language, a declarative format for managing build-time configuration options. The package is typically installed as part of ESP-IDF but can be used independently to configure embedded projects, validate configuration files, and generate documentation.

The package depends on pyparsing for language parsing, textual for terminal components, and esp-pylib for Espressif utilities. It runs on Python 3.8 and later across macOS, Windows, and POSIX systems. The tool is positioned as the standard configuration handler for ESP-IDF projects, with IDE support and documentation generation as core features.

Use it for:

- Configure Espressif microcontroller projects using kconfig syntax within the ESP-IDF build system
- Validate project configuration files before compilation to catch configuration errors early
- Generate human-readable configuration documentation from kconfig definitions
- Integrate configuration management into embedded development IDEs via IDE support

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Provides kconfig language support and IDE tooling for configuring Espressif ESP-IDF embedded projects, including configuration parsing, validation, and documentation generation.

Yes, if you are developing with ESP-IDF. The package is production-stable, actively maintained, has no known vulnerabilities, and installs with minimal friction. It is the standard tool for kconfig support in the ESP-IDF ecosystem. Install it as part of ESP-IDF or independently if you need standalone kconfig tooling for Espressif projects.

## Install

pip install esp-idf-kconfig
uv add esp-idf-kconfig
poetry add esp-idf-kconfig

## Installing esp-idf-kconfig

Before you install: Low install friction; pure Python wheel with no compiled dependencies. Actively maintained with recent releases and supported on modern Python versions.

License in practice: Apache 2.0 permissive license allows commercial and private use with minimal restrictions; derivative works and modifications are permitted provided license terms are included.

Quickstart:

pip install esp-idf-kconfig

import esp_idf_kconfig
# Use for parsing and validating kconfig files in ESP-IDF projects

Verify before relying:

- Whether the package can be used standalone or requires ESP-IDF SDK installation
- Specific IDE integration capabilities beyond configuration parsing and documentation generation
- Whether textual dependency provides a terminal UI or is used internally

## Package facts

- License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for… (full text in the JSON record) (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 1.4M/month (top 5,000 on PyPI)
- Known vulnerabilities: none known

## Tags

kconfig configuration tool, esp-idf project configuration, embedded systems config management, kconfig language parser, espressif ide support, embedded-systems, esp-idf

[View on SkillFed](https://skillfed.io/packages/esp-idf-kconfig) · [View on PyPI](https://pypi.org/project/esp-idf-kconfig/)