Welcome to kiutils’s documentation!

This is the documentation to the kiutils python module for parsing files of the KiCad EDA.

• View on Github: mvnmgrx/kiutils

kiutils is simple and SCM-friendly KiCad file parser based on Python dataclasses for KiCad 6.0 and up.

It 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.

Usage

• Installation
• Getting started
  • Simple examples
• Examples
  • Loading and saving a board
  • Changing title and revision in schematic
  • Loading and adding footprint to board
  • Adding vias to board
• Development
  • Tests
  • Generate documentation

Misc

• Known issues

Module documentation

• kiutils package
  • Board files (kiutils.board)
  • Design Rules (kiutils.dru)
  • Footprints (kiutils.footprint)
  • Library tables (kiutils.libraries)
  • Schematics (kiutils.schematic)
  • Symbols and Symbol Libraries (kiutils.symbol)
  • Worksheets (kiutils.wks)
• kiutils.items package
  • Board items (kiutils.items.brditems)
  • Common items (kiutils.items.common)
  • Dimensions (kiutils.items.dimension)
  • Footprint items (kiutils.items.fpitems)
  • Graphical items (kiutils.items.gritems)
  • Schematic items (kiutils.items.schitems)
  • Symbol items (kiutils.items.syitems)
  • Zone items (kiutils.items.zones)
• kiutils.utils package
  • String manipulation (kiutils.utils.strings)
  • S-Expr parser (kiutils.utils.sexpr)
• kiutils.misc package
  • Configuration stuff (kiutils.misc.config)

Indices and tables

• Index

• Module Index