About
- Python Package Name: kicad_bom
- Description: KiCad Python code for generating bill of materials in multiple formats.
- Python Package Exports: KicadBom, save_all_csv_files
- Version: 5.0.1
- Python Version: 3.9
- Release Date: 2023-03-30
- Creation Date: 2022-08-16
- License: BSD-3-Clause
- URL: https://github.com/janelia-pypi/kicad_bom
- Author: Peter Polidoro
- Email: peter@polidoro.io
- Copyright: 2023 Howard Hughes Medical Institute
- References:
- https://gitlab.com/kicad/code/kicad
- Dependencies:
- kicad_netlist_reader
Example Usage
Python
from kicad_bom import KicadBom
netlist_path = '.'
output_path = 'test/bom'
kb = KicadBom(netlist_path, output_path)
kb.save_all_csv_files()
column_names = ['Item',
'Quantity',
'Manufacturer',
'Manufacturer Part Number',
'Description',
'Reference(s)',
'Package']
format_for_org_table = True
bom = kb.get_bom(column_names, format_for_org_table)
Installation
https://github.com/janelia-pypi/python_setup
GNU/Linux
Python Code
The Python code in this library may be installed in any number of ways, chose one.
-
pip
python3 -m venv ~/venvs/kicad_bom source ~/venvs/kicad_bom/bin/activate pip install kicad_bom
-
guix
Setup guix-janelia channel:
https://github.com/guix-janelia/guix-janelia
guix install python-kicad-bom
Windows
Python Code
The Python code in this library may be installed in any number of ways, chose one.
-
pip
python3 -m venv C:\venvs\kicad_bom C:\venvs\kicad_bom\Scripts\activate pip install kicad_bom
Development
Clone Repository
git clone git@github.com:janelia-pypi/kicad_bom.git
cd kicad_bom
Guix
Install Guix
Edit metadata.org
make -f .metadata/Makefile metadata-edits
Tangle metadata.org
make -f .metadata/Makefile metadata
Develop Python package
make -f .metadata/Makefile guix-dev-container
exit
Test Python package using ipython shell
make -f .metadata/Makefile guix-dev-container-ipython
import kicad_bom
exit
Test Python package installation
make -f .metadata/Makefile guix-container
exit
Upload Python package to pypi
make -f .metadata/Makefile upload
Docker
Install Docker Engine
https://docs.docker.com/engine/
Develop Python package
make -f .metadata/Makefile docker-dev-container
exit
Test Python package using ipython shell
make -f .metadata/Makefile docker-dev-container-ipython
import kicad_bom
exit
Test Python package installation
make -f .metadata/Makefile docker-container
exit