kicad2junit 0.1.5

Convert KiCad ERC/DRC report to Junit reports

kicad2junit

A utility to convert KiCad DRC/ERC reports to Junit reports for CI/CD checks.

Install

The utility is available on pypi and can be installed by pip: pip install kicad2junit

Usage

DRC

usage: drc2junit [-h] [--project [PROJECT]] [--project-dir PROJECT_DIR] [--warn-error] [input] [output]

Convert KiCad DRC report to JUnit

positional arguments:
  input                 JSON DRC report
  output                JUnit XML output

options:
  -h, --help            show this help message and exit
  --project [PROJECT]   Kicad project file
  --project-dir PROJECT_DIR
                        Kicad project directory
  --warn-error          Treat warnings as errors

Example

kicad-cli pcb drc /path/to/project.kicad_pcb --format json --output drc.json
drc2junit drc.json drc.junit.xml --project /path/to/project.kicad_pro

ERC

usage: erc2junit [-h] [--project [PROJECT]] [--project-dir PROJECT_DIR] [--warn-error] [input] [output]

Convert KiCad ERC report to JUnit

positional arguments:
  input                 JSON ERC report
  output                JUnit XML output

options:
  -h, --help            show this help message and exit
  --project [PROJECT]   Kicad project file
  --project-dir PROJECT_DIR
                        Kicad project directory
  --warn-error          Treat warnings as errors

Usage

kicad-cli sch erc /path/to/project.kicad_sch --format json --output erc.json
erc2junit erc.json erc.junit.xml --project /path/to/project.kicad_pro

Exit code

The exit code is set to 1 (Failure) if one or more errors are found (and warnings if --warn-error is used).