Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve development speed by linting for circuit python spec #27

Open
nateinaction opened this issue Aug 2, 2024 · 3 comments
Open
Assignees

Comments

@nateinaction
Copy link
Member

nateinaction commented Aug 2, 2024

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 nateinaction changed the title Improve development speed by linting for micropython spec Improve development speed by linting for circuit python spec Aug 4, 2024
@nateinaction
Copy link
Member Author

nateinaction commented Aug 4, 2024

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.

@nateinaction
Copy link
Member Author

nateinaction commented Jan 4, 2025

Ultimately what I have found is that you can install circuit python stubs with the circuitpython_setboard command. However your board needs to be included in a circuitpython release. The circuitypython team has a guide on how to add your board here.

It looks like we also must have a unique VID:PID for the board: https://learn.adafruit.com/how-to-add-a-new-board-to-circuitpython/frequently-asked-questions

@nateinaction nateinaction self-assigned this Jan 5, 2025
@nateinaction
Copy link
Member Author

Contributing the v4 board definition to the circuitpython repo is in-flight but waiting on our USB VID:PID application.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant