MicroPython Stubs: Enhance Your Development Experience

Welcome to the MicroPython Stubs repository!

Here, you’ll find a treasure trove of over 3,000 stub files generated by the MicroPython-Stubber tool. Whether you’re just starting out or a seasoned developer, these stubs are designed to supercharge your MicroPython development process.

Stubs are like cheat sheets for your code. They provide hints, auto-completion, and static type checking, making your life as a developer easier and more productive. Here’s what you can expect from these MicroPython stubs:

• Faster Coding: With stubs, you’ll write code more quickly and confidently. No more guessing function names or parameters!
• Fewer Errors: Stubs help catch mistakes early. If you provide incorrect arguments, you’ll get immediate feedback.
• Code Completion: Say goodbye to endless Bingling. Stubs provide context-aware auto-completion, even for board-specific features.
• Static Type Checking: By adding typing information, you’ll catch type-related bugs before they cause runtime issues.

Installation

For installation instructions and configuration of your preferred IDE, please refer to the documentation

Explore Available Stubs

Curious about which versions, ports, and boards are covered? Check out the online viewer or search for MicroPython stub packages on PyPI.

For a comprehensive overview of all stubs, dive into the documentation on the documentation on read the docs.

Sponsoring

In order to build accurate stubs I need access to a board to flash it with a specific version of MicroPython and run part of the stubbing software (createsubs.py) on the board.

You can help me by:

• running the software and sharing a PR with the generated MCU stubs,

• sending me a spare board you may have,

• or by sponsoring me though Github

Contributors

Thanks to everyone that has submitted stubs or other relevant pieces of code and information, or published relevant stubs on pypi or github.

Jos Verlinde 💻 📝 ✔ 🔧	MicroPython 🔣 📝	Boris Lovosevic 🔣 📝	Paul Sokolovsky 🔣 📝	pycopy 🔣 📝	Pycom 🚇	Braden Mars 📝 ✔ 🔧 📦
Paul Sokolovsky 📝	Daryl Stultz 📝	Patrick ✔ 📝	Callum Jacob Hays 💡 🔬	Ronald Hiemstra 📝 🖋 📖	Chris Wood 📝 🔧	thingslu 📝 ✔
Matin Tat ✔	Roberto Jose Etcheverry Romero ✔	jdsmith ✔	Mr Keuz 💻 ✔	Matt Trentini 📝	Andrew St Clair 📝	Michal Moravec 🐛
Paul 🔧 📝 🐛	Sam Duke 🐛

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.