Skip to content

installation.md

Latest commit

 

History

History
89 lines (67 loc) · 3.61 KB

installation.md

File metadata and controls

89 lines (67 loc) · 3.61 KB
Raw

Installation

Platform matrix

Tiers are the org's platform support tiers.

Platform Arch Tier Path
MicroPython / CircuitPython (any MCU or unix port) any CI-proven (unix port) MIP / pure-Python copy — see below
CPython — Linux manylinux x86_64 CI-proven Native wheel (TestPyPI)
CPython — Windows AMD64 CI-proven Native wheel (TestPyPI)
CPython — Android arm64_v8a, x86_64 community-verified Native wheel (TestPyPI); builds, never run on a device here
Pyodide / browser wasm32 community-verified Native wheel (TestPyPI); pyemscripten_2025_0 for cp313, pyemscripten_2026_0 for cp314
CPython — macOS x86_64, arm64 — No wheel: no Mac on the bench — use MIP / pure-Python
CPython — Linux aarch64 aarch64 — No wheel: no aarch64 runner — use MIP / pure-Python

Current releases go to TestPyPI; install from there. Production PyPI holds one older release (0.0.37, against TestPyPI's 0.0.38), parked to reserve the name, so a plain pip install pydevices-pygraphics succeeds and gives the older wheel.

The public API is the same on both builds except for four authoring entry points — export_framebuffer, and FrameBuffer.export / from_bitmap / from_module — which are pure-Python only. See what the native build does not have.

MicroPython (MIP)

import mip
mip.install("pygraphics", index="https://PyDevices.github.io/mip")

The package path on mip is micropython/pygraphics/ (import name pygraphics). Older installs that used MIP name graphics should reinstall under the new name — the cutover publish already went out.

CircuitPython / copy install

Copy the pygraphics/ package folder onto sys.path (from lib/pygraphics/ in this repo, or from mip).

To link the native cmod into a CircuitPython unix build (out-of-tree Extending CircuitPython layout via spike + apply_cp_patches.sh — see the repository README):

# siblings: circuitpython/ and pygraphics/
./apply_cp_patches.sh --apply
cd ../circuitpython/ports/unix && make -j VARIANT=coverage

Tested against CircuitPython 10.2.1; the MicroPython recipe is tested against v1.28.0 and current master.

See the org's optional aggregator workspace for an easier way to build this repo with other user C modules (MicroPython) or extensions (CircuitPython).

CPython — native/C extension (preferred when available)

pip install \
  -i https://test.pypi.org/simple/ \
  --extra-index-url https://pypi.org/simple/ \
  pydevices-pygraphics

Pyodide / browser (WASM)

Each TestPyPI release includes wasm wheels — pyemscripten_2025_0_wasm32 for cp313 and pyemscripten_2026_0_wasm32 for cp314 (same semver). micropip selects the one matching your runtime automatically:

import micropip
await micropip.install("pydevices-pygraphics", index_urls="https://test.pypi.org/simple/")

Name cutover

Role Current Retired (do not use)
Import pygraphics graphics
Pure-Python pip Not published; use MIP pygraphics
Native/C pip pydevices-pygraphics pygraphics, graphics-cmod
MIP pygraphics graphics

TestPyPI may still list the old project names until they age out; install the current names above.