Full clone

A pydevices-examples clone contains examples, application helpers, documentation, and the PyScript/PWA site. Reusable product libraries are installed packages or come from a sibling pydevices checkout.

Download

git clone https://github.com/PyDevices/pydevices-examples.git
cd pydevices-examples

Layout

pydevices-examples/
├── lib/examples/       # portable demos and applications
├── lib/utils/          # example and GUI integration helpers
├── .site/pyscript/       # live gallery and reusable PWA shell
├── packages/           # GitHub MIP manifests for examples/helpers
└── tools/              # cross-runtime test harnesses

For a complete editable workspace:

git clone https://github.com/PyDevices/pydevices.git
git clone https://github.com/PyDevices/pydevices-examples.git

Keep the two repositories as siblings. lib/utils/path.py recognizes that layout and adds the product lib, utils, display, and audio source trees.

Run on desktop

The simplest route installs the TestPyPI products into a virtual environment:

cd pydevices-examples
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
cd lib
../.venv/bin/python examples/pydevices_demo.py

See Desktop CPython for system dependencies and editable source paths.

Run on a microcontroller

Install product and board packages using the pydevices workflows, then install pydevices-examples's examples.json and utils.json when desired. See the ESP32 guide.

Regenerate gallery manifests

When example or utility files change, maintainers run:

./scripts/install_refresh_manifests.sh
python scripts/gallery_generator.py

Product publishing and MIP synchronization are owned by pydevices.