Skip to main content

Scripts, templates, and examples for managing KiCad projects.

Project description

Welcome to kicad-helpers

Scripts, templates, and examples for managing KiCad projects

Build, Test, Package PyPI version shields.io

Project goals

  • provide a sensible default structure and scripts for managing KiCad projects
  • automate everything that can be automated with continuous integrations scripts (e.g., 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

Setup a new project

Open a command line shell and navigate to the directory containing your KiCad project. Then run kh_update to apply various project templates to the project directory:

> cd kicad/project/path
> kh_update

By default, this will install the following templates:

To overwrite existing templates, run kh_update with the --overwrite flag:

> kh_update --v --overwrite
Rendering kitspace.yaml template.
Rendering settings.ini template.
Rendering .github/workflows/build.yml template.
Rendering .kicad_helpers_config/config.kibot.yaml template.
Rendering .kicad_helpers_config/manufacturers/PCBWay.kibot.yaml template.
Rendering tests/tests.ipynb template.

To see the options that are available, run the command:

> kh_update --help
usage: kh_update [-h] [--v] [--overwrite] [--root ROOT]

Install various 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: .)

Export a BOM from the KiCad schematic

> kh_sch_to_bom --v
/home/ryan/miniconda3/envs/kh/bin/python3.9 -m kifield --nobackup --overwrite --group -aq -x /mnt/c/Users/ryan/OneDrive/dev/python/kicad-helpers/_temp/40-channel-hv-switching-board.sch -i /mnt/c/Users/ryan/OneDrive/dev/python/kicad-helpers/_temp/manufacturing/default/40-channel-hv-switching-board-BOM.csv

Import data from the BOM into the KiCad schematic

> kh_sch_to_bom --v
/home/ryan/miniconda3/envs/kh/bin/python3.9 -m kifield --nobackup --overwrite --fields ~quantity -x /mnt/c/Users/ryan/OneDrive/dev/python/kicad-helpers/_temp/manufacturing/default/40-channel-hv-switching-board-BOM.csv -i /mnt/c/Users/ryan/OneDrive/dev/python/kicad-helpers/_temp/40-channel-hv-switching-board.sch

Run all tests in the tests directory

> kh_test
testing /mnt/c/Users/ryan/OneDrive/dev/python/kicad-helpers/_temp/tests/Tests.ipynb
All tests are passing!

Contributors

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_helpers-0.10.tar.gz (22.6 kB view hashes)

Uploaded Source

Built Distribution

kicad_helpers-0.10-py3-none-any.whl (22.8 kB view hashes)

Uploaded Python 3

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