Adding option to install library stubs from PyPi #229
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implementation of feature request #140, this is something I would really like to see as a PyCharm user.
As described in the PyCharm + CircuitPython setup guide there are packages available on PyPi that contain stubs for libraries from the Adafruit Library Bundle, these packages help give the IDE you are using context for your CircuitPython code so that code hinting can work properly.
Instead of having to manually install these stubs after installing packages using CircUp, this PR adds the
--stubs
flag to thecircup install
command which enables a step in the installation process to try to install the available stubs package usingpip
.This would currently only work for libraries in the Adafruit CircuitPython Bundle, as I don't see an easy way to find out whether there are stubs packages on PyPi for any other CircuitPython libraries.