MCPcopy
hub / github.com/yaqwsx/KiKit

github.com/yaqwsx/KiKit @v1.8.0 sqlite

repository ↗ · DeepWiki ↗ · release v1.8.0 ↗
1,067 symbols 3,260 edges 67 files 434 documented · 41%
README

KiKit – Automation for KiCAD

KiKit Logo

KiKit is a Python library, KiCAD plugin and a CLI tool to automate several tasks in a standard KiCAD workflow like:

KiKit Promo

Do You Enjoy KiKit or Does It Save You Time?

Then definitely consider:

Your support will allow me to allocate time to properly maintain my projects like this.

PS: Be sure to check out my other KiCAD & PCB related projects:

Installation

KiKit is available as a PyPi package. However, due to packaging of KiCAD, installation on some platforms requires usage of specific Python interpreter.

Please follow the detailed installation guide that covers installation based on the platform you use.

Why Should I Use It?

Everything KiKit does, can also be done via Pcbnew in KiCAD. However, you have to do it manually. One of the common scenarios is the creation of panels. Most of the tutorials on the internet guide you to use the "append board" functionality of Pcbnew. However, this approach is labour-intensive, error-prone and whenever, you change the board, you have to do it again.

With KiKit you just call a CLI command if you have a simple layout (e.g., a grid) or write few Python instructions like "place board here", "add bridge here", "separate boards via mouse bites/v-cuts" and you are done. The process is repeatable and actually much simpler than hand-drawing the panels. KiKit also allows you to easily export all the Gerbers in a single step.

You can then write a Makefile and simply call make to get all your manufacturing data and board presentation pages.

Feature List

How To Use It?

Start with reading the panelization documentation. This page will you guide through CLI, GUI and scripting usage. Also don't miss the examples. There is also a quick note on how to use panelization action plugin. If you are interested in generating solder paste stencils, see Stencil documentation

Acknowledgements

The project is supported by:

KiKit Is Broken or Does Not Work as Expected

Please, first check FAQ. If you have not found answer for your problem there, feel free to open an issue on GitHub.

If you would like to have a feature in KiKit that is currently not on a roadmap, or if you need to prepare custom panelization script (e.g., multi-design panels, panels with specific arrangement), you can consider hiring me to do the job. Just reach out to me via e-mail and we can discuss further details.

Core symbols most depended-on inside this repo

toKiCADPoint
called by 135
kikit/common.py
typeIn
called by 99
kikit/panelize_ui_sections.py
fromMm
called by 96
kikit/common.py
items
called by 42
kikit/drc.py
always
called by 40
kikit/panelize_ui_sections.py
runBoardExample
called by 27
kikit/doc.py
autoName
called by 26
scripts/exampleDoc.py
toMm
called by 21
kikit/common.py

Shape

Method 468
Function 456
Class 133
Route 10

Languages

Python100%

Modules by API surface

kikit/panelize.py150 symbols
kikit/substrate.py91 symbols
kikit/panelize_ui_sections.py71 symbols
kikit/actionPlugins/panelize.py66 symbols
kikit/intervals.py58 symbols
versioneer.py50 symbols
kikit/common.py48 symbols
kikit/sexpr.py40 symbols
kikit/panelize_ui_impl.py38 symbols
kikit/plugin.py35 symbols
kikit/drc.py30 symbols
kikit/fab/common.py28 symbols

Dependencies from manifests, versioned

@fullhuman/postcss-purgecss2.1.0 · 1×
cssnano5.1.14 · 1×
postcss7.0.36 · 1×
postcss-purgecss2.0.3 · 1×
tailwindcss1.2.0 · 1×

For agents

$ claude mcp add KiKit \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact