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.

Installing KPM

Open the "KiCad Command Prompt"

pip3 install kicad-package-manager

Usage

kpm init

kpm install https://github.com/danroblewis/kicad-eurorack-tools.git

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": {
		"jlcpcb-basics": "0.0.1",
		"eurorack-parts": "0.0.57"
	}
}

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.10.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

kicad_package_manager-0.0.10-py2.py3-none-any.whl (7.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.10.tar.gz
Algorithm Hash digest
SHA256 2e2d2dfebfa438d3d7558c926375028971de15432b2f66dce375a13f743d4951
MD5 e3ee2541d05de8cd3a8f315428cfeba3
BLAKE2b-256 dd7426dc06aa540643295bd33db61ccb8c6829857158eef2db90fc4cd02949de

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 65d48ba7ede1fb4336cb0090dbae5a2fbaed4121a0aaa248013b4d102c359e60
MD5 a7fc45e51226214a3e8187ef5aae7329
BLAKE2b-256 3fd5abf0318383b9deb81674a581ba66d46e6360aa127ee11cf3b8e5c1367180

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