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 .

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

Uploaded Source

Built Distribution

kicad_package_manager-0.0.6-py2.py3-none-any.whl (7.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: kicad_package_manager-0.0.6.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for kicad_package_manager-0.0.6.tar.gz
Algorithm Hash digest
SHA256 290c0c4f7b0ba5f87aaf07bc5df01331bc996f47a04c7f4fac2e1903a24af718
MD5 a5747d616dc95d79e07e0005d8e122a7
BLAKE2b-256 e69fabfa45dc1f6cec0b2696a8cfbc18974b3dd32f400c5c91bcab30787a8f2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d4fc1174eb98076e5ac3515b7f0168eef62916465bf3d0420513704fd86e8b29
MD5 1d9b2371a1d71b2fb45518b6fbd10c4f
BLAKE2b-256 3752ddded977fcb5d3ea901552c5ab4c7e044d67430aa5510442a751c98c9a36

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