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

Uploaded Source

Built Distribution

kicad_package_manager-0.0.5-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.5.tar.gz.

File metadata

  • Download URL: kicad_package_manager-0.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 a0a231345aa2d9d983baa6f23ece0a5081faf912834841300ab91991942a5dc4
MD5 89098f418cf944cce01e2f0e5aac4c12
BLAKE2b-256 0c671dc5db283eafc65283a2a065a31e25003bc9861fdc0ff494cbf80ed0dfae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kicad_package_manager-0.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 79dc2e944377ff615e5a1664781e2054fd9cc05cae9e6dd04e457e092a5485e8
MD5 80382d187b951f9fd122cd24cd1bcfb3
BLAKE2b-256 c17a6d703f91c532724a4676a676ca17d3462399b3f11631c7af7c79ac3d4d4a

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