Examples, integrations and gallery work belong here. Fixes to the reusable libraries and to hardware support belong in pydevices. A new example, or a fix to one that doesn't run on a board you have, is a good first contribution.
| Path | What's there |
|---|---|
lib/examples/ |
Portable examples and complete demo applications |
lib/utils/ |
Example helpers and third-party GUI adapters |
.site/pyscript/ |
The PyScript gallery and the browser demo runners |
docs/ |
The documentation site's source, and the screenshots |
tools/ |
Cross-interpreter example and LVGL test harnesses |
packages/ |
GitHub MIP manifests for examples and helpers |
tests/ |
Unit tests for the examples, utilities, gallery and tooling |
python3 -m venv .venv
.venv/bin/pip install --index-url https://test.pypi.org/simple/ \
--extra-index-url https://pypi.org/simple/ -r requirements.txt -r requirements-dev.txt
.venv/bin/python -m unittest discover -s tests
.venv/bin/python -m pytest -s tests -q
.venv/bin/ruff check lib tests tools scriptstools/README.md describes the cross-interpreter example
matrix and the PyScript and Playwright debugging notes. AGENTS.md
lists the repository's conventions for application ownership and board configs.
python tools/screenshot.py hello.py
python tools/record.py bouncing_balls 10Output goes to docs/screenshots/ and docs/videos/.
pip install -r docs/requirements.txt
sphinx-build -W --keep-going -b html docs _site-W fails on any warning, as Read the Docs does.