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

Uploaded Source

Built Distribution

kicad_package_manager-0.0.8-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.8.tar.gz.

File metadata

  • Download URL: kicad_package_manager-0.0.8.tar.gz
  • Upload date:
  • Size: 6.8 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.8.tar.gz
Algorithm Hash digest
SHA256 a0d9437d263d9c57ddc74eb12cfd644d9fb758c8981633aaca291ecc8d6925d9
MD5 8ac62a6193d1abbfc60f8ec0afb1abe4
BLAKE2b-256 083431f468f72335f2a26d5b6707cb6be743e2cbc65f9cc6e19992c7e41e1e9b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f4b0834b208b81ea044fbe9aad9836719bc132eb747c2b3005d533ac85c140a5
MD5 af60d4685ce57b759932cd55a5ce815b
BLAKE2b-256 c772de5d1ac603e2df2ceb32437e0d9bc80548cbefce85886d0738b3f69da0f0

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