search

proveskit / circuitpy_flight_software

Flight software for the PROVES Kit.
MIT License
2 stars 4 forks source link

Improve development speed by linting for circuit python spec #27

Closed nateinaction closed 1 month ago

nateinaction commented 1 month ago

Recently tried running #26 on the satellite and received the following error no module named 'dataclasses'. We should try to lint to ensure all code adhears to the ~micropython~ circuit python standard so devs receive quick feedback to know that their code will work at least run when uploaded to the satellite. I suspect this would have saved me about an hour.

nateinaction commented 1 month ago

Research notes: Started off with a blog article describing a vscode micropython linting setup which lead me to micropy-cli. micropy-cli aims to offer linting, intellisence, autocompletion, and dependency management for free as long as you can specify the board you're using. I then started trying to understand how to specify our custom board definition and with Michael's help was pointed to the CircuitPython build data for the Proveskit board. Finally I found the CircuitPython Stubs package and a pretty recent issue describing an imperfect but serviceable way to set up a custom stub pinout.