Convert new_keyboard.sh to a python command

qmk / qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families

https://qmk.fm

GNU General Public License v2.0

17.97k stars 38.62k forks source link

Convert new_keyboard.sh to a python command #6872

Closed skullydazed closed 2 years ago

skullydazed commented 4 years ago

Feature Request Type

[x] Core functionality
[ ] Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
[ ] Alteration (enhancement/optimization) of existing feature(s)
[ ] New behavior

Description

Similar to #6066, we should convert new_keyboard.sh to a qmk command.

Some thoughts on implementation:

The cleanest way to handle the templates is probably by using .format() string formatting.
Like new_keymap the user should be able to supply answers on the command line. Any information not provided should be prompted for.
This is an instance where most (all?) CLI flags should be arg_only=True.

HBBisenieks commented 4 years ago

Is the intention that this be, essentially, a drop-in replacement for the current .sh version with the addition of CLI flags that supersede the interactive prompts?

skullydazed commented 4 years ago

As a start, yes. I think there will be room to iterate and improve on it once that is done, and I'd welcome most of those improvements as part of the initial PR. For example, support for arm keyboards.

HBBisenieks commented 4 years ago

~~I'm making a branch on my fork to get the ball rolling on this, and I'll open a PR when it's at least feature-complete with the .sh version.~~ LOL @stjohnjohnson beat me to it.

stjohnjohnson commented 4 years ago

@HBBisenieks sorry!

HBBisenieks commented 4 years ago

Hey no worries! Your implementation looks way better than mine was looking in the planning stages.

thiagoyeds commented 4 years ago

Hi @skullydazed, what is the advantage of replacing .sh with a python command? Better debugging?

lf- commented 4 years ago

@ThiagoWhispher I'm going to go for maintainability, consistency in output/behaviour, reliability, and moving all the shell stuff to the qmk utility.

stjohnjohnson commented 4 years ago

I like the idea of centralizing all these commands into a single CLI. Combine that with the Docker container and you have a single command with no dependencies (besides Docker) for all operations.

thiagoyeds commented 4 years ago

@lf- now I understand how advantageous this is. @stjohnjohnson I working with Docker, and strongly recommend, very practical to work.

helios1101 commented 4 years ago

Are these docker images hosted on Docker Hub too? Just wanted to start my journey in containers as it would be my first experience with dockers contribution.

stjohnjohnson commented 4 years ago

@helios1101 https://hub.docker.com/r/qmkfm/qmk_firmware for example

ShiftyBlock commented 4 years ago

Looking at the other comments, at first I was confused about the purpose of it now, but I rethought about it and it's usage is quite widespread.

ShiftyBlock commented 4 years ago

Just wondering, is there a pr that has handles/is handing this request?

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs. For maintainers: Please label with bug, in progress, on hold, discussion or to do to prevent the issue from being re-flagged.