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

Uploaded Source

Built Distribution

kicad_package_manager-0.0.4-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.4.tar.gz.

File metadata

  • Download URL: kicad_package_manager-0.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 4e2de88ab5910060ba62a044bc2d2f7bd4a12558998cb7a7b550900361ed1f5c
MD5 12c28df51ecbfdf97d388f2622379012
BLAKE2b-256 a8d0e21ae8edf897d42bce904ab80d52090e324bd3e8f0c8701a4102c9c8dc85

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 371dc394f4babce3c0abfed8d0cf17b185da604bbc7e63bf1d04317b5e421c21
MD5 44de9095d5f2050c363800a3c0cad485
BLAKE2b-256 ab5b19bcf588b9b1edcf3d455a2e0e34c920d2c30c1a8a543aefbea225278132

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