huas-micropython 0.0.2

Micropython stub files and dependencies

Micropython type hints and additional requirements

About this package

huas-micropython packages MicroPython stub files, adding type information for static type checkers like MyPi or pyright.

IDE's which use these type checkers (e.g. VSCode or PyCharm) will in turn be able to provide rich MicroPython type hinting, code completion and contextual help to the user, increasing the overall developer experience without the need to install additional pugins.

• In addition to providing MicroPyton type stubs this package adds esptool and adafruit-ampy as optional install requirement, see background for a rationale.

• This package intends to be a transitional package meaning that at some point in time it will become obsolete depending on community MicroPython stub packaging efforts, see development for more information.

Installation

You can install huas-micropython easily from Python's package index. In a terminal run the following command for a full install which includes type stubs and additionally installs the esptool and adafruit-ampy packages:

 pip install huas-micropython[all]

Note on some Linux and macOS systems you might need to run as root with sudo:

sudo pip3 install huas-micropython[all]

For a plain install which only contains the type stubs, run the following:

 pip install huas-micropython

Background

This module was created to support students at Hanzehogeschool University of Applied Sciences's bachelor HBO-ICT programme (in Dutch), in particular for students participating in the Internet of Things project.

This package adds esptool and adafruit-ampy as an optional install requirement to provide all the tooling necessary for working with an esp32 microcontroller. Note that adafruit-ampy is also included in PyCharm's Micropython plugin and as such huas-micropython offers functional parity.

Development

Current efforts to maintain Micropython type stubs are at Josverl/micropython-stubs and hlovatt/PyBoardTypeshed. The huas-micropython package includes both, using Josverl/micropython-stubs for module level stubs and hlovatt/PyBoardTypeshed as additional documentation stubs (as a sidenote, PyCharm's Micropython plugin uses hlovatt/PyBoardTypeshed stubs).

Two ongoing iniatives are of importance for this package:

• Integrating and/or combinging work being done at both stub repositories (being discussed at #98).

• Publishing stubs to PyPi, see e.g. #123 and #179.

Once the above has been resolved huas-micropython will be considered obsolete and retracted from PyPi.