Installation overview

pydisplay supports three install channels. Pick based on whether you need the full repo, source files on device, or precompiled bytecode.

Comparison

Channel	Format	Install tool	Includes examples	Includes add_ons
Full clone	Entire repo	git clone	Yes	Yes
GitHub MIP	Source .py	mip / mpremote mip	Optional (examples.json)	Yes (add_ons.json)
micropython-lib MIP	Precompiled .mpy	mip with custom index	No	No

The installer.py script combines GitHub and micropython-lib installs in one call — recommended for MicroPython boards.

What gets installed

Core libraries (under src/lib/):

• displaysys — display drivers (BusDisplay, SDL2Display, etc.)
• eventsys — input events and device brokers
• graphics — extended drawing helpers
• palettes — color palettes
• multimer — cross-platform timers (CPython, MicroPython, CircuitPython unix). Asyncio timers: multimer.aio — see multimer

Optional packages:

• add_ons — framebuf shim, console, pdwidgets, displaybuf, etc.
• examples — demo scripts
• spibus / i80bus — MicroPython bus drivers (viper; GitHub only)

Board support:

• board_config.py per hardware — see board configs
• Display and touch drivers from drivers/

PyPI / pip

CPython wheels are built to TestPyPI for maintainer testing. End-user pip install is not documented yet. Use a full clone or desktop quick start.

After installing

1. Provide or install a board_config.py matching your hardware.
2. Follow the quick start for your platform:
3. ESP32 / MCU
4. Desktop CPython
5. Wokwi

Troubleshooting

See Troubleshooting for import errors, MIP failures, and display issues.