Skip to main content

A package manager for KiCad projects

Project description

KiCad Package Manager

This is a package manager for KiCad symbols, footprints, 3d models, simulation files, and hierarchical sheets.

Goal

Create a format for distributing the following kind of KiCad features:

  • Symbols
  • Footprints
  • 3D Models
  • SPICE Simulation Code
  • Sub-sheets
  • Unit Tests
  • Command Runner
  • Plugins

Projects can be created that programmatically generate these files.

Currently Supports:

  • Symbols
  • Footprints

Up Next:

  • 3D Models
  • Command Runner
  • SPICE Simulation Code

Installing KPM

Open the "KiCad Command Prompt"

pip3 install kicad-package-manager

Usage

kpm init
kpm list
kpm search jlc
kpm show kpm-jlcpcb-basic
kpm install .

To add a new package to the package index, submit a pull request

kpm.json

{
	"name": "cool-project",
	"version": "0.0.1",
	"author": "danroblewis",
	"homepage": "http://githab.info/magic/stuff",
	"commands": {
		"test": "./fictional-spice-tester"
	},
	"dependencies": {
		"kpm-jlcpcb-basic": "0.0.5",
		"eurorack-parts": "0.0.1"
	}
}

Refresh Symbols and Footprints

After updating your libraries, the symbols/footprints in your schematic files won't have the latest changes. Do this to synchronize them:

  • In eeschema, click Tools > Update Symbols from Library..., then save
  • In pcbnew, click Tools > Update Footprints from Library..., then save

(If we can find a way to do this within kpm, that would be awesome.)

Package Directory Structure

/kpm.json

/symbols/
/symbols/mysymbols.kicad_sym

/footprints/
/footprints/myfootprints.pretty/
/footprints/myfootprints.pretty/myfootprints.kicad_mod

/3dmodels/
/3dmodels/something.step

/plugins/
/plugins/kicad-eurorack-tools/
/plugins/kicad-eurorack-tools/__init__.py

/simulation/
/simulation/mysim.spice

/sheets/
/sheets/mysubsheet.kicad_sch

/tests/
/tests/mytest.py

/scripts/
/scripts/mycommand.py

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

kicad_package_manager-0.0.14.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

kicad_package_manager-0.0.14-py2.py3-none-any.whl (8.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file kicad_package_manager-0.0.14.tar.gz.

File metadata

File hashes

Hashes for kicad_package_manager-0.0.14.tar.gz
Algorithm Hash digest
SHA256 d6fd2cf11ab937d7b290f743a901b49521d1936d7a5f7943886eebdfae99e1d9
MD5 cf0d9924d1bf718ca1e258cdd4d0630b
BLAKE2b-256 c656260d374bc8d7d844627d14f0f2a517e29caa380d501616f23e71a7951670

See more details on using hashes here.

File details

Details for the file kicad_package_manager-0.0.14-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for kicad_package_manager-0.0.14-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 38dd4fd648e2675a0fdf3c8638ee5e319ebe7f329dbd5e9ef39e711802f363e6
MD5 bcb9b1902f4f84c98f6bfd7299439ff3
BLAKE2b-256 4104c9222d96ba808a8e008d8396f2b2f0d9a20cef04b9546e229b0f4bfe4961

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