Installation on MacOS, KiCAD not found

[tikiss]

Hello,
I am trying to use the KiBot on MacOS, the installation had no problem with pip.
I have than run the kibot-check and it is reporting that I have no KiCAD installation (and also other plugin like ibom is missing) but I habe it installed. I am using the KiCAD 8.
Here is the outcome of the kibot-check:

KiBot installation checker

Core:
Darwin
Python: 3.11.4 (main, Jun 20 2023, 17:23:00) [Clang 14.0.3 (clang-1403.0.22.14.1)]
**> KiCad not installed or not available in the path
KiCad: Not available
Kibot: 1.7.0

Modules:
Colorama: 0.4.6
LXML: Not available
Lark: 1.1.9
PyYAML: 6.0.1
QRCodeGen: Ok
Requests: 2.32.3
XLSXWriter: 3.1.2
Xvfbwrapper: Ok
markdown2: 2.4.13
numpy: 1.25.2

Tools:
Bash: 3.2.57 (GNU bash, version 3.2.57(1)-release (arm64-apple-darwin23))
Blender: Not available
Ghostscript: Not available
Git: 2.39.3 (git version 2.39.3 (Apple Git-146))
ImageMagick: Not available
Interactive HTML BoM: Not available
KiBoM: Not available
KiCad Automation tools (kiauto): 2.3.2 (pcbnew_do 2.3.2 - Copyright 2018-2024, INTI/Productize SPRL - License: Apache)
KiCad PCB/SCH Diff (kidiff): Not available
KiCost: Not available
KiKit: 1.5.1 (python -m kikit.ui, version 1.5.1)
OpenSCAD: Not available
Pandoc: Not available
RAR: Not available
RSVG tools: Not available
Xvfb: Not available

* KiBot is currently tested under Linux
  MacOSX should be supported for KiCad 6.x
   Please consult: https://github.com/INTI-CMNB/KiBot/issues

* Install KiCad 5.1.6 or newer
  Download it from: https://www.kicad.org/download/

* Blender not installed or too old
  Visit: https://www.blender.org/
  - Mandatory for `blender_export`

* Ghostscript not installed or too old
  Visit: https://www.ghostscript.com/
  Download it from: https://github.com/ArtifexSoftware/ghostpdl-downloads/releases
  This tool might be automatically downloaded by KiBot.
  - Optional to:
    - Create outputs preview for `navigate_results`
    - Create PNG, PS and EPS formats for `pcb_print`

* ImageMagick not installed or too old
  Visit: https://imagemagick.org/
  Download it from: https://imagemagick.org/script/download.php
  This tool might be automatically downloaded by KiBot.
  - Optional to:
    - Automatically crop images for `blender_export`
    - Create outputs preview for `navigate_results`
    - Create monochrome prints and scaled PNG files for `pcb_print`
    - Create JPG and BMP images for `pcbdraw`
    - Automatically crop images for `render_3d`

* Interactive HTML BoM not installed or too old
  Visit: https://github.com/INTI-CMNB/InteractiveHtmlBom
  Download it from: https://github.com/INTI-CMNB/InteractiveHtmlBom/releases
  This tool might be automatically downloaded by KiBot.
  - Mandatory for `ibom`

* KiBoM not installed or too old
  Visit: https://github.com/INTI-CMNB/KiBoM
  Download it from: https://github.com/INTI-CMNB/KiBoM/releases
  This tool might be automatically downloaded by KiBot.
  - Mandatory for `kibom`

* KiCad PCB/SCH Diff not installed or too old
  Visit: https://github.com/INTI-CMNB/KiDiff
  Download it from: https://github.com/INTI-CMNB/KiDiff/releases
  This tool might be automatically downloaded by KiBot.
  - Mandatory for: `diff`, `kiri`

* KiCost not installed or too old
  Visit: https://github.com/hildogjr/KiCost
  Download it from: https://github.com/hildogjr/KiCost/releases
  This tool might be automatically downloaded by KiBot.
  - Mandatory for `kicost`
  - Optional to find components costs and specs for `bom`

* Python module `LXML` not installed, too old or incompatible
  run `pip3 install LXML` as root,
  or run `pip3 install --user LXML` as a regular user
  - Mandatory for: `pcb_print`, `pcbdraw`

* OpenSCAD not installed or too old
  Visit: https://openscad.org/
  Download it from: https://openscad.org/downloads.html
  - Mandatory for: `stencil_3d`, `stencil_for_jig`

* Pandoc not installed or too old
  Visit: https://pandoc.org/
  Download it from: https://github.com/jgm/pandoc/releases
  In CI/CD environments: the `kicad_auto_test` docker image contains it.
  - Optional to create PDF/ODF/DOCX files for `report`

* RAR not installed or too old
  Visit: https://www.rarlab.com/
  Download it from: https://www.rarlab.com/download.htm
  This tool might be automatically downloaded by KiBot.
  - Optional to compress in RAR format for `compress`

* RSVG tools not installed or too old
  Visit: https://gitlab.gnome.org/GNOME/librsvg
  This tool might be automatically downloaded by KiBot.
  - Optional to:
    - SVG logos for the BoM for `bom`
    - Create outputs preview for `navigate_results`
    - Create PNG icons for `navigate_results`
    - Create PDF, PNG, PS and EPS formats for `pcb_print`
    - Create PNG, JPG and BMP images for `pcbdraw`

* Xvfb not installed or too old
  Visit: https://www.x.org
  - Mandatory for: `stencil_3d`, `stencil_for_jig`


Color reference: ok, optional for an output, optional for general use, mandatory for an output, mandatory for general use

Did this help? Please consider commenting it on https://github.com/INTI-CMNB/KiBot/discussions/categories/kibot-check

Do I missing something? I have tried to search what could be the solution but found nothing or one hint is maybe some environmental variables are missing?
Can you please help me?

Thanks in advance!

[set-soft]

Hi @tikiss !
Can you run the kicad command from the same shell?
What do you get when running: which kicad

[set-soft]

Ok, you should try to use the one shipped with KiCad, try:

PATH=/Applications/KiCad/KiCad.app/Contents/Frameworks/Python.framework/Versions/Current/bin:$PATH

Now the python3 command should be the one from KiCad (3.9.13), verify it.
Try running kibot-check using this python, i.e. python3 PATH_TO_KIBOT_CHECK, what do you get now?

[tikiss]

Okay, I have added that path, and now seems to work, the only interreseting thing, I have Interactive BOM (2.9.0) installed and KiBoM as well

KiBot installation checker

Core:
Darwin
Python: 3.9.13 (v3.9.13:6de2ca5339, May 17 2022, 11:37:23)  [Clang 13.0.0 (clang-1300.0.29.30)]
./src/common/stdpbase.cpp(59): assert ""traits"" failed in Get(): create wxApp before calling this
KiCad: 8.0.3
Kibot: 1.7.0
* KiBot is installed but not available in your PATH
  Try adding `/Users/tibi/Library/Python/3.9/bin/` to your PATH
  I.e.: export PATH=$PATH:/Users/tibi/Library/Python/3.9/bin/
    ~  export PATH=$PATH:/Users/tibi/Library/Python/3.9/bin/                                                                                   1 ✘  7s 
    ~  python3 /Users/tibi/Library/Python/3.9/bin/kibot-check                                                                                           ✔
KiBot installation checker

Core:
Darwin
Python: 3.9.13 (v3.9.13:6de2ca5339, May 17 2022, 11:37:23)  [Clang 13.0.0 (clang-1300.0.29.30)]
./src/common/stdpbase.cpp(59): assert ""traits"" failed in Get(): create wxApp before calling this
KiCad: 8.0.3
Kibot: 1.7.0

Modules:
Colorama: 0.4.6
LXML: Not available
Lark: 1.1.9
PyYAML: 6.0.1
QRCodeGen: Ok
Requests: 2.32.3
XLSXWriter: 3.2.0
Xvfbwrapper: Ok
markdown2: 2.4.13
numpy: 2.0.0

Tools:
Bash: 3.2.57 (GNU bash, version 3.2.57(1)-release (arm64-apple-darwin23))
Blender: Not available
Ghostscript: Not available
Git: 2.39.3 (git version 2.39.3 (Apple Git-146))
ImageMagick: Not available
Interactive HTML BoM: Not available
KiBoM: Not available
KiCad Automation tools (kiauto): 2.3.2 (pcbnew_do 2.3.2 - Copyright 2018-2024, INTI/Productize SPRL - License: Apache)
KiCad PCB/SCH Diff (kidiff): Not available
KiCost: Not available
KiKit: 1.5.1 (kikit, version 1.5.1)
OpenSCAD: Not available
Pandoc: Not available
RAR: Not available
RSVG tools: Not available
Xvfb: Not available

* KiBot is currently tested under Linux
  MacOSX should be supported for KiCad 6.x
   Please consult: https://github.com/INTI-CMNB/KiBot/issues

* Blender not installed or too old
  Visit: https://www.blender.org/
  - Mandatory for `blender_export`

* Ghostscript not installed or too old
  Visit: https://www.ghostscript.com/
  Download it from: https://github.com/ArtifexSoftware/ghostpdl-downloads/releases
  This tool might be automatically downloaded by KiBot.
  - Optional to:
    - Create outputs preview for `navigate_results`
    - Create PNG, PS and EPS formats for `pcb_print`

* ImageMagick not installed or too old
  Visit: https://imagemagick.org/
  Download it from: https://imagemagick.org/script/download.php
  This tool might be automatically downloaded by KiBot.
  - Optional to:
    - Automatically crop images for `blender_export`
    - Create outputs preview for `navigate_results`
    - Create monochrome prints and scaled PNG files for `pcb_print`
    - Create JPG and BMP images for `pcbdraw`
    - Automatically crop images for `render_3d`

* Interactive HTML BoM not installed or too old
  Visit: https://github.com/INTI-CMNB/InteractiveHtmlBom
  Download it from: https://github.com/INTI-CMNB/InteractiveHtmlBom/releases
  This tool might be automatically downloaded by KiBot.
  - Mandatory for `ibom`

* KiBoM not installed or too old
  Visit: https://github.com/INTI-CMNB/KiBoM
  Download it from: https://github.com/INTI-CMNB/KiBoM/releases
  This tool might be automatically downloaded by KiBot.
  - Mandatory for `kibom`

* KiCad PCB/SCH Diff not installed or too old
  Visit: https://github.com/INTI-CMNB/KiDiff
  Download it from: https://github.com/INTI-CMNB/KiDiff/releases
  This tool might be automatically downloaded by KiBot.
  - Mandatory for: `diff`, `kiri`

* KiCost not installed or too old
  Visit: https://github.com/hildogjr/KiCost
  Download it from: https://github.com/hildogjr/KiCost/releases
  This tool might be automatically downloaded by KiBot.
  - Mandatory for `kicost`
  - Optional to find components costs and specs for `bom`

* Python module `LXML` not installed, too old or incompatible
  run `pip3 install LXML` as root,
  or run `pip3 install --user LXML` as a regular user
  - Mandatory for: `pcb_print`, `pcbdraw`

* OpenSCAD not installed or too old
  Visit: https://openscad.org/
  Download it from: https://openscad.org/downloads.html
  - Mandatory for: `stencil_3d`, `stencil_for_jig`

* Pandoc not installed or too old
  Visit: https://pandoc.org/
  Download it from: https://github.com/jgm/pandoc/releases
  In CI/CD environments: the `kicad_auto_test` docker image contains it.
  - Optional to create PDF/ODF/DOCX files for `report`

* RAR not installed or too old
  Visit: https://www.rarlab.com/
  Download it from: https://www.rarlab.com/download.htm
  This tool might be automatically downloaded by KiBot.
  - Optional to compress in RAR format for `compress`

* RSVG tools not installed or too old
  Visit: https://gitlab.gnome.org/GNOME/librsvg
  This tool might be automatically downloaded by KiBot.
  - Optional to:
    - SVG logos for the BoM for `bom`
    - Create outputs preview for `navigate_results`
    - Create PNG icons for `navigate_results`
    - Create PDF, PNG, PS and EPS formats for `pcb_print`
    - Create PNG, JPG and BMP images for `pcbdraw`

* Xvfb not installed or too old
  Visit: https://www.x.org
  - Mandatory for: `stencil_3d`, `stencil_for_jig`


Color reference: ok, optional for an output, optional for general use, mandatory for an output, mandatory for general use

Did this help? Please consider commenting it on https://github.com/INTI-CMNB/KiBot/discussions/categories/kibot-check

[set-soft]

Ok, one problem I see is that you installed KiBot using the pip tool from /usr/bin/python3, I guess that because kibot-check complains that the script isn't in the path (is in /Users/tibi/Library/Python/3.9/bin/).
I think you should try to uninstall KiBot using the same pip tool you used to install it. Then install it using the KiCad python.

Now about iBoM and KiBoM, do you know where are they installed? How did you install them? The iBoM script is generate_interactive_bom.py and the KiBoM script is KiBOM_CLI.py

[tikiss]

Yes, I have installed it:
pip3 install kibot --user
Than I have:
export PATH=$PATH:/Users/tibi/Library/Python/3.9/bin/
Okay, I have uninstalled it, but which way should I use to install? I am bit confused, I have read through the documentation but not found anything special for MacOS.
Interractive BOM tool is installed though KiCAD, and it can found:
~/Documents/KiCad/8.0/3rdparty/plugins/org_openscopeproject_InteractiveHtmlBom/generate_interactive_bom.py
I cannot remember how I installed KiBOM, but with pip I cannot found it, so I guess I have cloned the git, and it is stored here (on my NAS drive):
/Volumes/Docs/Elektronika/KiCAD/_plugins/KiBoM/KiBOM_CLI.py
P.s.: many thanks that you take your time and guide me to get it running.

[set-soft]

Yes, I have installed it: pip3 install kibot --user Than I have: export PATH=$PATH:/Users/tibi/Library/Python/3.9/bin/ Okay, I have uninstalled it, but which way should I use to install? I am bit confused, I have read through the documentation but not found anything special for MacOS.

Most macOS users use docker images, like most Windows users. If you are patient just install it from the git repo, using the dev branch and report issues. If not just use docker images.
Docker images will be slow, but all functionality will be available.

Interractive BOM tool is installed though KiCAD, and it can found: ~/Documents/KiCad/8.0/3rdparty/plugins/org_openscopeproject_InteractiveHtmlBom/generate_interactive_bom.py

Ok, I'm adding ~/Documents/KiCad/
Patch 04228ed should fix it

I cannot remember how I installed KiBOM, but with pip I cannot found it, so I guess I have cloned the git, and it is stored here (on my NAS drive): /Volumes/Docs/Elektronika/KiCAD/_plugins/KiBoM/KiBOM_CLI.py

How do you access it? Is it in your path?

P.s.: many thanks that you take your time and guide me to get it running.

As I don't have a MacOS system I need people testing and reporting issues. Most of the problems are related to the particular directory structure.

[alextrical]

Im in a similar boat. Getting KiBot instaled locally on a (ARM64) M1 Macbook
So far using the information here, I've been able to compile and run kibot-check
using the following commands

git clone -b dev https://github.com/INTI-CMNB/KiBot.git
cd KiBot

PATH=/Applications/KiCad/KiCad.app/Contents/Frameworks/Python.framework/Versions/Current/bin:$PATH
pip3 install lark qrcodegen colorama xlsxwriter pyyaml kiauto
python3 setup.py build
python3 setup.py install

Output from kibot-check is the following

Core:
Darwin
Python: 3.9.13 (v3.9.13:6de2ca5339, May 17 2022, 11:37:23)  [Clang 13.0.0 (clang-1300.0.29.30)]
./src/common/stdpbase.cpp(59): assert ""traits"" failed in Get(): create wxApp before calling this
KiCad: 8.0.3
Kibot: 1.8.3

Modules:
Colorama: 0.4.6
LXML: Not available
Lark: 1.2.2
PyYAML: 6.0.2
QRCodeGen: Ok
Requests: 2.32.3
XLSXWriter: 3.2.0
Xvfbwrapper: Ok
markdown2: 2.5.1
numpy: 2.0.2

Tools:
Bash: 3.2.57 (GNU bash, version 3.2.57(1)-release (arm64-apple-darwin23))
Blender: Not available
Ghostscript: Not available
Git: 2.47.0 (git version 2.47.0)
ImageMagick: Not available
Interactive HTML BoM: Not available
KiBoM: Not available
KiCad Automation tools (kiauto): 2.3.3 (pcbnew_do 2.3.3 - Copyright 2018-2024, INTI/Productize SPRL - License: Apache)
KiCad PCB/SCH Diff (kidiff): Not available
KiCost: Not available
KiKit: 1.6.0 (kikit, version 1.6.0)
OpenSCAD: Not available
Pandoc: Not available
RAR: Not available
RSVG tools: 2.58.4 (rsvg-convert version 2.58.4)
- Missing test tool `convert`
Xvfb: Not available

* KiBot is currently tested under Linux
  MacOSX should be supported for KiCad 6.x or newer
   Please consult: https://github.com/INTI-CMNB/KiBot/issues

Unfortunatly when I try to run KiBot, regardless of the command, it results in the following error

It looks like KiKit on mac had a similar issue here yaqwsx/KiKit#252 though im struggling to see how to resolve the issue here

[set-soft]

Hi @alextrical !
I'll suggest avoiding the following steps:

python3 setup.py build
python3 setup.py install

And try KiBot "in-place", just run the "src/kibot" script from the repo. The above error might be some issue with write permissions.

[alextrical]

Unfortunatly running in that way results in the following error

even though it looks like the module is available

Ive cleared out the files installed through Build and install, removed all Pip/pip3 installed packages, and gone back to a blank slate for the Python3 environment.

[alextrical]

Some progress. Using
python3 src/kibot
results in the expected output

Getting closer

[alextrical]

The Consolidate_PCBs example is working on this end. The following commands where run to install KiBot locally (not intergrated, but working so far)

git clone -b dev https://github.com/INTI-CMNB/KiBot.git
cd KiBot
PATH=/Applications/KiCad/KiCad.app/Contents/Frameworks/Python.framework/Versions/Current/bin:$PATH
pip3 install pyyaml lxml lark
python3 src/kibot

[set-soft]

Some progress. Using
python3 src/kibot

Yes, the shebang assumes you want to use the system level python (/usr/bin/python3), so if you use other Python (the one in KiCad) then you must invoke the python interpreter explicitly.