Skip to main content

Simple and SCM-friendly KiCad file parser for KiCad 6.0 and up

Project description

KiUtils

PyPI version PyPI downloads 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!

Project details


Download files

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

Source Distribution

kiutils-1.4.8.tar.gz (84.0 kB view details)

Uploaded Source

Built Distribution

kiutils-1.4.8-py3-none-any.whl (93.8 kB view details)

Uploaded Python 3

File details

Details for the file kiutils-1.4.8.tar.gz.

File metadata

  • Download URL: kiutils-1.4.8.tar.gz
  • Upload date:
  • Size: 84.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for kiutils-1.4.8.tar.gz
Algorithm Hash digest
SHA256 18c5803283e579cfe8772955e7702548d7139e0fc630daa579ed6b2b767db846
MD5 54c24b72550c5da7c0306556eee3ebc9
BLAKE2b-256 db0704d7a636eaf9f54f6e7cdfc2117843ef4cc6a6360a9866fbd76bc2a0d0dd

See more details on using hashes here.

File details

Details for the file kiutils-1.4.8-py3-none-any.whl.

File metadata

  • Download URL: kiutils-1.4.8-py3-none-any.whl
  • Upload date:
  • Size: 93.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for kiutils-1.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ca7c5c7eafb7bc33daa3d6cfe42cc704be2bcd2206103b28ad2682d88a6072ae
MD5 afad7abbae7c621a2bed36f640a62722
BLAKE2b-256 8cc0381ece43b464ce8aff02a327b0d5cdc011b8c0d9a652e245b05e0bb0810a

See more details on using hashes here.

Supported by

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