kicadcliwrapper 1.0.4

Kicad-CLI python bindings

KiCAD CLI python bindings

Strongly typed, auto-generated python bindings for KiCAD's command line interface.

Usage

Setup

pip install kicadcliwrapper

Examples

from kicadcliwrapper.generated.kicad_cli import kicad_cli

# Get version
kicad_cli(
    kicad_cli.version(),
).exec()


# Export pdf for pcb
kicad_cli(
    kicad_cli.pcb(
        kicad_cli.pcb.export(
            kicad_cli.pcb.export.pdf(
                INPUT_FILE="input.kicad_pcb"
            )
        )
    ),
).exec()

For more examples you can check faebryk

Development

git clone https://github.com/faebryk/kicadcliwrapper.git
poetry install

# Re-generate bindings (make sure kicad-cli is installed)
python src/kicadcliwrapper/main.py

See PARSER.md for an explanation of the internal parsing.

MIT License

Copyright (c) 2024 faebryk

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.