README.md

• About

• Installation

• Development

About

- Python Package Name: kicad_netlist_reader
- Description: KiCad python module for interpreting generic netlists which can be used to generate bills of materials.
- Python Package Exports: netlist, comp, xmlElement, libpart
- Version: 7.0.1
- Python Version: 3.9
- Release Date: 2023-03-29
- Creation Date: 2014-12-09
- License: GPL-3.0
- URL: https://github.com/janelia-python/kicad_netlist_reader
- Author: Jean-Pierre Charras
- Email: [email protected]
- Copyright: 2023 KiCad
- References:
  - https://gitlab.com/kicad/code/kicad

Installation

https://github.com/janelia-python/python_setup

GNU/Linux

Python Code

The Python code in this library may be installed in any number of ways, chose one.

1. pip

   python3 -m venv ~/venvs/kicad_netlist_reader
   source ~/venvs/kicad_netlist_reader/bin/activate
   pip install kicad_netlist_reader

2. guix

   Setup guix-janelia channel:

   https://github.com/guix-janelia/guix-janelia

   guix install python-kicad-netlist-reader

Windows

Python Code

The Python code in this library may be installed in any number of ways, chose one.

1. pip

   python3 -m venv C:\venvs\kicad_netlist_reader
   C:\venvs\kicad_netlist_reader\Scripts\activate
   pip install kicad_netlist_reader

Development

Clone Repository

git clone [email protected]:janelia-python/kicad_netlist_reader.git
cd kicad_netlist_reader

Guix

Install 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_netlist_reader
exit

Test Python package installation

make -f .metadata/Makefile guix-container
exit

Upload Python package to pypi

make -f .metadata/Makefile upload