kigadgets
a.k.a. kicad-python: atait fork Development of a stable Python scripting API for KiCad based on Piers Titus van der Torren work and community feedback.
KiCad and pcbnew expose a python interface that allows plugins and other procedural processing of PCB layouts. While it is a major differentiator of KiCad, there are limitations of using this python API directly. kigadgets attempts to simplify the software design to a level where hardware designers are able to write (and maintain) their own code for software-assisted layout.
kigadgets implements cross-version compatible and more intuitive patterns for objects, properties, units, string layers, and so on.
It constructs an environment where pcbnew.py functionality can be used headless (outside the GUI), and the pcbnew GUI can import external python packages at runtime.
Furthermore, it enables patterns for more advanced software engineering such as multiple entry points, layout hashes, and regression tests.
This package has been fully tested with KiCad 5.0-9.0 (Mac/Windows/Linux). See tests to reproduce headless behavior and examples to reproduce GUI behavior. Note that v9 will give warnings about SWIG.
An excerpt
A simple pythonic script might look like this
print([track.layer for track in pcb.tracks])
print([track.width for track in pcb.tracks if track.is_selected])
which produces
[F.Cu, B.Cu, B.Cu]
[0.8, 0.6]
The python wrapper is handling things like calling the (sometimes hard to find) function names, sanitizing datatypes, looking up layers, and enabling the list comprehension.
track and board use properties to give an intuition of state, but they are dynamically interacting with the underlying C++ PCB_TRACK and BOARD that you see in the layout editor.
Installation via PyPI
pip install kigadgets
python -m kigadgets
The python -m kigadgets command automatically links paths needed for headless scripts to import the pcbnew module and for GUI plugins to find python packages external to KiCad, including kigadgets. For more detail on what the linker is doing, why, and advanced options, see here.
Mac users: There is an extra step. The above command will walk you through it. For more information about kipython on Mac, see the docs.
Try it out: Quit and reopen pcbnew application. Open its terminal, then run
pcb.add_circle((100, 100), 20, 'F.Silkscreen'); pcbnew.Refresh()
Snippet examples
These snippets are run in the GUI terminal. There is no preceding context; the linking step above provides pcb to the terminal. More examples in the docs.
Hide silkscreen labels of selected footprints
for fp in pcb.footprints:
if fp.is_selected:
fp.reference_label.visible = False
pcbnew.Refresh()
Change all drill diameters
Because planning ahead doesn't always work
for v in pcb.vias:
if v.drill > 0.4 and v.drill < 0.6:
v.drill = 0.5
pcbnew.Refresh()
Select everything schematically connected to this footprint
footprint = pcb.selected_items[0]
nets = {pad.net_name for pad in footprint.pads}
nets -= {'GND', '+5V'} # because these are connected to everything
for mod in pcb.footprints:
if any(pad.net_name in nets for pad in mod.pads):
mod.select()
User input via layout
from kigadgets.drawing import Rectangle
my_rect = Rectangle((0,0), (60, 40))
pcb.add(my_rect)
pcbnew.Refresh()
print(my_rect.x, my_rect.contains((1,1))) # 30 True
input('Go move that rectangle. When done, refocus in this terminal and press enter.')
# Go move the new rectangle in the editor
print(my_rect.x, my_rect.contains((1,1))) # 15.2 False
pcb.remove(my_rect)
pcbnew.Refresh()
Stodgier features
While helpful for small scripting (above), kigadgets also provides significant support for maintaining more complicated codebases that use pcbnew.py. It can give cross-version compatibility, code that reads better, and multiple CLI/API/GUI entry points.
All kigadgets.BoardItems are hashable based on their geometric contents.
Together with lytest, these enable automated testing and things like diff --stat, ultimately giving more workflow options for developing action plugins and batch processing scripts.
TODO verify this link: See discussion on software engineering features in the docs.
Related Projects
KiCad has a rich landscape of user-developed tools, libraries, and plugins. It is worth understanding this landscape in order to use the right tool for the job, whether it turns out to be kigadgets, others, or multiple.
See discussion of the landscape in the documentation.
Metadata
Release files for kigadgets 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| kigadgets-0.5.0.tar.gz | 42.0 kB | Without provenance | Details for kigadgets-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| kigadgets-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for kigadgets-0.5.0-py3-none-any.whl |
Total release size: 82.7 kB
Release files / kigadgets-0.5.0.tar.gz
| Download URL | kigadgets-0.5.0.tar.gz |
|---|---|
| Size | 42.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8281f1ae850fa3d523f3807b78fce3a27331deba07e63fced3345f3dc69ca2da
|
|
BLAKE2b-256 checksum How to use checksums |
4f285b0eedafa661e80f09f747761700b5494b3196f7e34a803d47e5d1427967
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.9.18
|
Release files / kigadgets-0.5.0-py3-none-any.whl
| Download URL | kigadgets-0.5.0-py3-none-any.whl |
|---|---|
| Size | 40.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1dd36077ba34e73c7dec77109b244711fcb2f3ad3d2774d3ec9647123af0c238
|
|
BLAKE2b-256 checksum How to use checksums |
82a966f92a8c5e1b85345c190e535be66882bccaf25cf7cbffa55138535bdee3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.9.18
|
Security for kigadgets 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.