/kiutils

Simple and SCM-friendly KiCad file parser based on Python dataclasses for KiCad 6.0 and up.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

KiUtils

PyPI version Python version License Last commit Documentation Status

Simple and SCM-friendly KiCad file parser based on Python dataclasses for KiCad 6.0 and up. The following KiCad-related files are currently supported:

  • .kicad_pcb - Board layouts
  • .kicad_sch - Schematics
  • .kicad_mod - Footprints
  • .kicad_sym - Symbols and symbol libraries
  • .kicad_wks - Worksheets
  • .kicad_dru - Custom design rules
  • fp-lib-table & sym-lib-table - Library tables

KiUtils implements a "pythonic" abstraction of the documentation found at the KiCad Developer Reference and is intended to work with an SCM like Git or SVN without breaking the layout of the files when the Python script ran.

Parsing of the files is based on the S-Expression parser found in this library: GitLab: KiCad Library utilities

Prerequisites

The following is required to use kiutils:

  • Python 3.7 or higher

Installation

kiutils is available on PyPI. Use Python's pip to install it:

pip install kiutils

If kiutils is already installed, upgrade it to the latest version using:

pip install --no-cache-dir --upgrade kiutils

Documentation

Visit the kiutils documentation for more information on how to install, use and develop kiutils, as well as examples and general module documentation.

Donate

If you found this module helpful for your project consider donating via PayPal. Thanks!