Metadata-Version: 2.1
Name: idf-ci
Version: 0.1.0
Summary: The python library for CI/CD of ESP-IDF projects
Author-email: Fu Hanxi <fuhanxi@espressif.com>
Project-URL: Homepage, https://github.com/espressif/idf-ci
Project-URL: Documentation, https://docs.espressif.com/projects/idf-ci
Project-URL: Repository, https://github.com/espressif/idf-ci.git
Project-URL: Changelog, https://github.com/espressif/idf-ci/blob/master/CHANGELOG.md
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: tomlkit
Requires-Dist: idf-build-apps <3,>=2.6.2
Requires-Dist: pytest-embedded-idf[serial] ~=1.13
Requires-Dist: pytest-embedded-jtag ~=1.13
Requires-Dist: pytest-embedded-qemu ~=1.13
Requires-Dist: pytest-ignore-test-results <1,>=0.3.0
Requires-Dist: pytest-timeout
Requires-Dist: rich
Provides-Extra: doc
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme ; extra == 'doc'
Requires-Dist: sphinx-copybutton ; extra == 'doc'
Requires-Dist: myst-parser ; extra == 'doc'
Requires-Dist: sphinxcontrib-mermaid ; extra == 'doc'
Requires-Dist: sphinx-argparse ; extra == 'doc'
Requires-Dist: sphinx-tabs ; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'

# idf-ci

![Python 3.7+](https://img.shields.io/pypi/pyversions/idf-ci)

This repo contains the tools for CI/CD of ESP-IDF projects.

## Configurations

`.idf_ci.toml` is the configuration file for `idf-ci`. It is a TOML file. The following reflects the default configurations:

```toml
# how to map the modified files into modified components
component_mapping_regexes = [
    "/components/(.+)/",
    "/common_components/(.+)/",
]
extend_component_mapping_regexes = []

# these files would be ignored when mapping the modified files into modified components
component_ignored_file_extensions = [
    ".md",
    ".rst",
    ".yaml",
    ".yml",
    ".py",
]
extend_component_ignored_file_extensions = []
```
