Getting started with python scripting

[bask185]

I want to start using python scripting for the sake of learning.

There are a few things I want to use it for.

• set silk texts of footprints
• add fields to all schematic symbols properties.

I have googled for things but I cannot find that much.

Getting started using Python Scripts

Can someone point me to a step by step guide to using python scripts? That is, given that someone has a cool script that I want to use: where do I put that .py script? how do I invoke it? do I need to install Python separately or is it included in the KiCad install? do I need to set up a new path? what else? I have tried copying the script into \KiCad\bin\scripting\plugins And then (from within layout) Tools > Scripting Console, "import " no dice. Seems like there should be a clear documen…

I have found this video earlier today.

Kicad schematics and PCB Python scripting

And this leads to my first question #1. I used pip to install the library, and it seems to work in python outside Kicad but ofcourse not in KiPython. How and where do I install libraries for KiPython

#2, other than being integrated in KiCad and containing pre-installed lbraries. Is there something special about KiPython in regards to regular python? Are there reasons why I really want to use KiPython instead of regular python?

#3 I used the library from the viedo to edit a schematic with some succes. Is there a native library in KiPyhton which can do the same? I only found a library to edit boards with

Kind regards

Bas

[devbisme]

To change silk texts of footprints, you would probably use pcbnew.py which acts as an API for kicad’s pcbnew program.

For changing symbol fields, you would have to use an external Python script to manipulate a kicad schematic or symbol library file. (This is what the kifield utility does.) There is currently no API for the schematic side of kicad.

For creating pcbnew plugins, there is a set of old tutorials written by a user https://kicad.mmccoo.com/. These can give you an outline of how to do it, but the pcbnew API has morphed since then so you’ll need to supplement it with newer material. Perhaps looking at some current plugin code would do that.

[BlackCoffee]

This (my video) shows Making a Basic ‘simple’ plugin. The Action (what it actually does isn’t important, the important part is getting the Structure correct so the Kicad will recognize it.

This is Not the newer ‘Official’ Plugin approach with Meta…etc. But, it still works by placing the xxx.py file into the User’s ‘Scripting’ folder…

I just made the Plugin shown in this Post so, the older process still works… The ‘Action’ your code does is up to you so, get a dumb-Action or just display some text to verify the Plugin process works, then do the real Action-Code…