Unclear how to use this

[henrebotha]

I'm very interested in what you've done here and would like to take a look at it. However, it is unclear to me how to actually get this to run.

I gather from dev.md that I need a binary called vulture. I'm guessing (due to that first npx line also invoking flake8) that this is another linting tool or similar, so it's probably this.

Then I see I need cq-editor. I attempt to install CQ-editor using the instructions on their repo, but no matter what I do I can't get it to open case_and_pcb.py per the third command in dev.md.

As I see it, these issues can be solved using the following:

1. A requirements.txt file specifying all dependencies, so that a user can pip install -r requirements.txt (as per Python best practice) to install every single dependency required by this project;
2. A clear guide (either in readme.md, or linked to from there) for getting this project up and running; and
3. A file (probably named main.py) that is clearly and unambiguously meant to serve as the entry point for this code.

[possibilities]

Hi Henré, Much of this is disorganized because the project is new and I've purposely not taken the time to make it friendly for others while concentrating on making other progress. Another reason is that I'm new to python so I don't know the best practices.

I think we can get everything in a better place pretty easily (maybe on some points you can answer some questions to help me) with the exception of maybe cadquery and cadquery editor. I'm fairly sure you'll have to install cq-editor and cadquery from master. Did you do that or some other way? If yes then what error do you get (or what else do you see) when you run cq-editor case_and_pcb.py?

Once we get that out of the way maybe I can ask you a couple questions to help me deal with the other stuff? Feel free to continue here or hit me up on discord at possibilities#8660.

[henrebotha]

I'm also not really a Python guy myself. But we can hack something together here with a bit of moxie.

I installed CQ-editor from the latest release here. I get an error about it not being able to find the sexpdata import. It appears that this CQ-editor bundles its own Python, and it's unclear to me how to install dependencies for this bundled Python as opposed to my system-wide Python. Gotta figure that one out.

[possibilities]

[reposted because email doesn't support markdown]

[possibilities]

Almost 100% sure you need both cq and cq-editor from master.

conda install -c cadquery -c conda-forge cadquery=master

conda install -c cadquery -c conda-forge cq-editor=master

My installation uses the system python as far as I can tell so I'm unsure why cq-editor would have that issue. If possible join the cadquery channel on the Elm server and either me and/or cadquery devs can help.

[possibilities]

BTW, I'm going to keep working on this project long term and so whatever progress we make here will be a benefit to me and the project. So I appreciate the questions and any input. But also I just wanted to make sure you know there are quite a few other similar projects (parameterized/generated keyboards and/or cases) that are more mature. Mostly I'm thinking of ~Absolem~ ergogen but I can dig up some other links too if you are interested. Again not trying to dissuade you from using or contributing here I'd love it, and I think there are some unique things about this project, but wanted to make sure you know there's other options if you want something more "ready".

[henrebotha]

Oh yeah for sure, my interest is more abstract than that. I'm happily designing my own keyboard from scratch!

[possibilities]

If you're not already there Absolem Discord is a great place for discussion and sharing ideas... though my guess is that's where you found this repo? :)

[henrebotha]

I can't even remember where I found this lol