Skip to main content

Kconfig tooling for esp-idf

Project description

esp-idf-kconfig

The esp-idf-kconfig package is part of the ESP-IDF SDK for Espressif products and is automatically installed.

It is responsible for enabling project configuration using the kconfig language, providing IDE support for configuration and configuration documentation generation.

For more information about how it works go to the documentation.

Contributing

Code Style & Static Analysis

Please follow these coding standards when writing code for esp-idf-kconfig:

Pre-commit checks

pre-commit is a framework for managing pre-commit hooks. These hooks help to identify simple issues before committing code for review.

To use the tool, first install pre-commit. Then enable the pre-commit and commit-msg git hooks:

python -m pip install pre-commit
pre-commit install -t pre-commit -t commit-msg

On the first commit pre-commit will install the hooks, subsequent checks will be significantly faster. If an error is found an appropriate error message will be displayed.

Conventional Commits

esp-idf-kconfig complies with the Conventional Commits standard. Every commit message is checked with Conventional Precommit Linter, ensuring it adheres to the standard.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

esp-idf-kconfig-2.2.0.tar.gz (137.5 kB view hashes)

Uploaded Source

Built Distribution

esp_idf_kconfig-2.2.0-py3-none-any.whl (142.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page