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

Uploaded Source

Built Distribution

kicad_package_manager-0.0.11-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.11.tar.gz.

File metadata

File hashes

Hashes for kicad_package_manager-0.0.11.tar.gz
Algorithm Hash digest
SHA256 1e7bfc916df02406a1c9410770b65e725ee62d703ed8505d9c2a21c633533ac1
MD5 93d0f6da8b3dfde38e56523afe38d215
BLAKE2b-256 436c6ddbf49aeeddd8fefaeadeefd7b3d68495607ef138f30561693abdeb6861

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 88da4ec143c08b9fd0f607aec17c66f6dd4090f0d66ee319f6adeb21e270b221
MD5 28100de1cfc0012b2bd86cc41cc44bab
BLAKE2b-256 898b2a1a3988e2046395770f61ddb2d569b8f9d8d37e47197ff81af17ec8be0a

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