Scripts, templates, and examples for managing KiCad projects.
Project description
kicad-helpers
Scripts, templates, and examples for managing KiCad projects.
Project goals:
- provide a sensible default structure and scripts for managing KiCad projects
- automate everything that can be automated (update BOMs, produce manufacturing files, run tests, generate documentation, etc.)
- configure git and KiCad to play nicely together
- support customization via command line arguments, environment variables, etc.
- make everything easy to install/setup/use
- make awesome documentation
Install
pip install kicad_helpers
How to use
Navigate to the directory containing your KiCad project:
cd kicad/project/path
Run the kh_update
script to update all project templates:
kh_update --help
usage: kh_update [-h] [--v] [--overwrite] [--root ROOT]
Update project templates from the `kicad_helpers/templates` directory (ignoring anything in the project's `.gitignore`
list).
optional arguments:
-h, --help show this help message and exit
--v verbose (default: False)
--overwrite overwrite existing templates (default: False)
--root ROOT project root directory (default: .)
The following templates are installed by default:
- .github/workflows/build.yml: a github workflow for updating the BOM, producing manufacturing files, running tests, generating documentation, etc.
- kitspace.yaml: metadata file for the kitspace service
- .kicad_helpers_config/config.kibot.yaml: configuration file for KiBot which allow automation of various KiCad actions
- .kicad_helpers_config/manufacturers/PCBWay.kibot.yaml: KiBot configuration to generate manufacturing files for PCBWay
To overwrite existing templates, run kh_update
with the --overwrite
flag:
kh_update --v --overwrite
kitspace.yaml already exists
Rendering kitspace.yaml template.
.github/workflows/build.yml already exists
Rendering .github/workflows/build.yml template.
.kicad_helpers_config/config.kibot.yaml already exists
Rendering .kicad_helpers_config/config.kibot.yaml template.
.kicad_helpers_config/manufacturers/PCBWay.kibot.yaml already exists
Rendering .kicad_helpers_config/manufacturers/PCBWay.kibot.yaml template.
tests/Tests.ipynb already exists
Rendering tests/Tests.ipynb template.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
kicad_helpers-0.7.1.tar.gz
(20.6 kB
view hashes)
Built Distribution
Close
Hashes for kicad_helpers-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 040057ff92b3cc9f08440b9db5d26c1961e1f2fd3bc910b566b3e2ae67e5efa0 |
|
MD5 | 5f084d35aad039691580a96c1e30e104 |
|
BLAKE2b-256 | efb3cafde1c24db10f06b38471fa203a992664a1e1d1dfe2dac3f2838f02670d |