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

Uploaded Source

Built Distribution

kicad_package_manager-0.0.13-py2.py3-none-any.whl (8.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.13.tar.gz
Algorithm Hash digest
SHA256 513b764f68f8c585c0234dd31a899b7d140f32adddb2238fa28a10d9256c97c4
MD5 4ab7fbf502ad895d17a74cb00920a47c
BLAKE2b-256 fcf1cc006195dba965892ec54d11b92260769ab9be9b0047d63b68f655469ba5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 651d7ef69659fdf585648ef4049b74dcf89804ee4dcf06cda19a58eea11bbddc
MD5 f4958368197c173a34ab8f79261cbf9c
BLAKE2b-256 d7f10da53838534dcc17aada9eb84557dfe8b124912f9a6a05c9af7fefe92aca

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