Skip to main content

Automation for KiCAD boards

Reason this release was yanked:

This version specifies minimal Python version wrongly.

Project description

KiKit - Automation for KiCAD

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

KiKit Promo

Do You Enjoy KiKit?

ko-fi

Installation

KiKit is available as a PyPi package, therefore, you can install it via pip:

pip3 install kikit

If you would like to test the upstream version (which can have more features implemented but is not guaranteed to be fully tested), you can install it via:

pip3 install git+https://github.com/yaqwsx/KiKit@master

Note that if you have a stable version installed, you need to add --force to upgrade it to upstream.

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.

See BatteryPack as an example usage of KiKit. Also see an example presentation page generated by KiKit.

Feature List

  • create panels by appending boards and pieces of substrate (bridges)
  • supports board with arbitrary shapes
  • easily create mouse-bites/V-CUTS
  • compared to hand-creation of panels, your panels will pass DRC (as tracks from different instances of the same board have distinct nets when using KiKit)
  • if you have multiple boards in a single file, you can split them
  • automated export of gerber files
  • 3D printed self-registering solder paste stencils
  • steel stencils with alignment jig

How To Use It?

Read the CLI documentation and the panelize documentation. Also don't miss the examples. If you are interested in generating solder paste stencils, see Stencil documentation

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.

How To Use It CI?

To use KiKit in CI (e.g., Travis) you can use prepared Docker image yaqwsx/kikit. Also see example .travis.yml.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

KiKit-0.5.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

KiKit-0.5-py3-none-any.whl (7.3 MB view details)

Uploaded Python 3

File details

Details for the file KiKit-0.5.tar.gz.

File metadata

  • Download URL: KiKit-0.5.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for KiKit-0.5.tar.gz
Algorithm Hash digest
SHA256 b99744ded2e227ce3cc2d0a572461a1cc01c5f0c97163a343be73398d012f2c1
MD5 6e38a4c34c2df39847bab79ff9cd73bf
BLAKE2b-256 df8ca074242777520b181bfd284c69a938f957cfd0cba167d159874565ce9254

See more details on using hashes here.

File details

Details for the file KiKit-0.5-py3-none-any.whl.

File metadata

  • Download URL: KiKit-0.5-py3-none-any.whl
  • Upload date:
  • Size: 7.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for KiKit-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6c1980dd42cd4a373f3c60d43f646c85ad6c14b6cc31bce70644ba364fc65e1e
MD5 0274466020853e223362b544cdf2914e
BLAKE2b-256 490bfaca3a89f919c7948485fcbadb3df83238f2c01055dd70bc09a783bca07d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page