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
1 maintainer
Metadata
1 maintainer
Release files for kicad-bom 5.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| kicad_bom-5.0.1.tar.gz | 5.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kicad_bom-5.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 11.7 kB
Release files / kicad_bom-5.0.1.tar.gz
| Download URL | kicad_bom-5.0.1.tar.gz |
|---|---|
| Size | 5.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
65d4ef44f082d220dfb78ef600be886a87aac871b210ac80f6c5f87b412ee2e4
|
|
BLAKE2b-256 checksum How to use checksums |
5ae89eeddd2d38f62c04786c4f57475b8b7b851e7c2c9549b796be23cd92e2e3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.8.3 requests/2.28.1 setuptools/64.0.3 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.9.9
|
Release files / kicad_bom-5.0.1-py3-none-any.whl
| Download URL | kicad_bom-5.0.1-py3-none-any.whl |
|---|---|
| Size | 6.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
164793feb826034fd5352d37f226b2b718ee85eb72ec4f477a680db795057a47
|
|
BLAKE2b-256 checksum How to use checksums |
6184d825ebfd8ea39fcfb10a3b26d6820e4e5f0d24ed0cde279da740189c6a4e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.8.3 requests/2.28.1 setuptools/64.0.3 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.9.9
|
Security for kicad-bom 5.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
