@ofborg build kicadPackages.kikit kicadPackages.kikit-library python310Packages.euclid3 python310Packages.kikit python310Packages.pcbnew-transition python310Packages.pybars3 python310Packages.pymeta3 python311Packages.euclid3 python311Packages.kikit python311Packages.pcbnew-transition python311Packages.pybars3 python311Packages.pymeta3

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/make-a-derivation-for-a-kicad-plugin/7317/19

wow, that's a lot of work, awesome

i'll do a review later

for now,
please separate the changes into a commit per package
especially separate commits for the maintainer-list changes

@evils hey friendly reminder. We've just unbroken installing packages via PCM.

nice

i've been a bit busier than expected, and don't immediately foresee a moment i'll have time

don't hesitate to poke me again in a week if i haven't gotten around to it then

@SuperSandro2000, we've pushed a commit addressing most of your feedback. Would appreciate if you could take another look!

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-summer-of-nix-program-goals/30376/12

@evils have a moment to review?

Just rebased on nixpkgs-unstable and tested locally again. Here's how to test locally:

nix-build -E 'let pkgs = (import ./. {}); in pkgs.kicad.override {addons=[pkgs.kicadAddons.kikit pkgs.kicadAddons.kikit-library];}'

Then create a project and look for the KiKit button in the toolbar. Click it. And if you happen to know how to use it, go ahead. We don't.

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review/3032/2824

I contacted @yaqwsx, the author of KiKit for help with verification.

Hi, I tried building the package, but I am unsure if I use Nix correctly. I run into two problems:

• when I run ./result/bin/pcbnew I get Could not determine wxPython version. Python plugins will not be available.
• I also struggle to find the kikit executable.

Once I build the package, how can I install it to test it properly? I also noticed that this package builds KiKit 1.3.0, however, 1.4.0 is the most recent release.

@yaqwsx thank you for trying! Funny. I don't get that wxPython related error.

The kikit executable on this branch can be obtained this way:

nix-build -E 'let pkgs = (import ./. {}); in pkgs.kikit'

And then look in result/

Regarding the version of KiKit, that is just a matter of bumping, I suppose. I'll try doing that.

@yaqwsx would you mind going on a call with me so that I could debug the wxPython error?

No problem with the call; I am busy for the rest of the week. What timezone are you in so I can suggest a time slot that would suit us both?

weird, our pcbnew is a wrapper that explicitly sets PYTHONPATH to include our wxPython and then calls the actual binary
i'm assuming you're not on NixOS and have an ambient wxPython installed, and that that's causing an issue

try nix-shell --pure -I nixpkgs=/path/to/your/nixpkgs/clone/with/these/changes -p kicad, this should at least clear env vars that may be pointing to another wxPython
(though it's entirely possible pcbnew finds wxPython in an FHS path, dunno what to do about that)
also try launching pcbnew via the kicad main window

@yaqwsx would you mind scheduling here?

@evils Even when I run KiCAD and open Pcbnew from it I get the same error message. When open the pure nix shell, I no longer get the error, but also the KiCAD doesn't see KiKit backend.

try nix-shell --pure -I nixpkgs=/path/to/your/nixpkgs/clone/with/these/changes -p kicad

That would result in a default kicad. Default kicad comes with no addons. Try this to obtain a pure nix shell with kicad and kikit:

nix-shell --pure -p 'let pkgs = (import ./. {}); in pkgs.kicad.override {addons=[pkgs.kicadAddons.kikit pkgs.kicadAddons.kikit-library];}'

To be clear, when that succeeds, you'd have a ./result/bin/kicad that should have kikit included. You should also have a ./result/bin/pcbnew that should work just fine, because of the magic of Nix.

Let us know, please.

Ok, with shell specififed as above, it seems to work just from KiCAD & Pcbnew. However, what I cannot get working is to invoke KiKit as a command line utility; the following should work: kikit --help. I just get Command not found.

Hi, yes, the last expression introduced kikit as only a kicad addon. You can use the following expresion to add kikit itself as well.

nix-shell --pure -p '
let pkgs = (import ./. {}); in 
[ 
  (pkgs.kicad.override { addons=[pkgs.kicadAddons.kikit pkgs.kicadAddons.kikit-library]; })
  pkgs.kikit
]'

nix-shell --pure -p 'let pkgs = (import ./. {}); in pkgs.kicad.override {addons=[pkgs.kicadAddons.kikit pkgs.kicadAddons.kikit-library];}'

To be clear, when that succeeds, you'd have a ./result/bin/kicad that should have kikit included. You should also have a ./result/bin/pcbnew that should work just fine, because of the magic of Nix.

Sorry, @yaqwsx. I mislead you with the paragraph above. nix-build produces a result directory. nix-shell, however, places you in a shell where the executables of the built packages are in the PATH. So, after running a nix-shell, don't execute ./result/bin/kicad. Instead, execute kicad.

With the last instructions, I was able to run both, KiKit from GUI and KiKit from CLI. The basic functionality works as expected.

The last thing is that if you want to build 3D-printed stencil (KiKit's command kikit stencil createprinted) it requires OpenSCAD to be installed. Which is not the case for the Nix package. However, we declare OpenSCAD as an optional dependency (mainly because of Windows). What do you think - should it or shouldn't it be included in the package?

Awesome feedback! OpenSCAD should not be a blocker for this PR. I suggest this can be merged.
@fricklerhandwerk