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

Uploaded Source

Built Distribution

kicad_package_manager-0.0.12-py2.py3-none-any.whl (8.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.12.tar.gz
Algorithm Hash digest
SHA256 d09b9c7266295d1e982c8148da8504d3123a4ebc5d4a8140f991b35247b5e6e8
MD5 b6f7661b26ff2af47dfa56e20b670b34
BLAKE2b-256 502020fc66fa1628efc107eb0fa039cb0b216b6085c00c4aac6f2cacf2d3547c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.12-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 31661595e7a7112ea915873a1d113b64069dd190ec947305fa717ef30529353a
MD5 c67217cfd19afb71b08cd393ae3e9db7
BLAKE2b-256 606de561d260bbfc4b125a7f03650915755d56037d376db8d2130e6404330324

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