micropython-stubs
This repo stores stubs generated by the MicroPython-Stubber tool. Currently over 3.000 stubfiles of multiple MicroPython versionas and modules are available to help you :
- write code quicker
- with less errors,
- get help from code completion,
- use static type checking,
- and improve the overall development experience while writing MicroPython.
The stubs are packaged and published to PyPi as Pep 561 stub-only packages to allow them to be installed and used with ease.
**Demo using VSCode: **
micropython-<port>[-<board>]-stubs
The stubs for a specific version port and board of the MicroPython firmware. These are built by combining: * The 'Board stubs' generated on a generic board for the port * The 'Frozen stubs' from the Micropython repository for that specific version and that port & board combination * The 'Core Stubs' to provide a common interface for the Micropython firmware and the CPython core.
Note: board is omitted if it is GENERIC
Examples:
- micropython-stm32-stubs
- micropython-esp32-stubs
- micropython-rp2-stubs
- micropython-esp8266-stubs
Current MicroPython stub packages
You can search for Micropython stub packages on PyPI
For a full overview of all stubs check out the documentation on read the docs, or in docs/firmware_grp.md
Using the stubs
To learn how to use the stubs please refer to the documentation on RTD
Contributors
Thanks to everyone that has submitted stubs or other relevant pieces of code and information, or published relevant stubs on pypi or github.
I invite everyone that has generated stubs for a board or port not on the current list, or has another contribution, to submit the stubs via a pull request or by just zipping up your stubs and creating an issue.
This project follows the all-contributors specification.