Metadata-Version: 2.4
Name: m5stack-stubs
Version: 0.1.0
Summary: Type stubs (.pyi) for the M5Stack UIFlow2 MicroPython firmware — M5 module
Project-URL: Homepage, https://github.com/N0I0C0K/m5stack-stubs
Author: N0I0C0K
License-Expression: MIT
Keywords: cardputer,m5stack,micropython,pyi,pylance,stubs,type-stubs,uiflow
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Stubs Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# m5stack-stubs

Type stubs (`.pyi`) for the **M5Stack UIFlow2** MicroPython firmware, so editors
(Pylance / pyright) give autocomplete and type checking for the `M5` module —
which is a compiled C module that no other stub package covers.

```bash
pip install m5stack-stubs
```

Then `import M5` resolves with real method signatures and constant values:

```python
import M5
M5.Lcd.fillRect(0, 0, 100, 50, 0xFFFF)   # fillRect(x, y, w, h, color=...) -> None
pressed: bool = M5.BtnA.isPressed()        # isPressed() -> bool
adv = M5.BOARD.M5CardputerADV              # 24
```

Generated from the official firmware C source by
[m5stubgen](https://github.com/N0I0C0K/m5stack-stubs). The package version tracks
the firmware release it was generated from.

> Stub-only package — it ships `.pyi` files only and has no runtime effect.

## License

MIT
