Skip to content
This repository was archived by the owner on Oct 28, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .site/wokwi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Use `main.py` as committed. On first boot, `mip` downloads PyDevices core + `pyg
PyDevices MIP index (network required), then runs **testris** — a touch + joystick Tetris demo. You
should see the game running — drive it with the on-screen touch keypad.

Only `testris.py` is installed from `lib/examples/`; the rest of the example catalog is not fetched.
Only `testris.py` is installed from [`lib/examples/`](../../lib/examples/); the rest of the example catalog is not fetched.
To try a different example, edit the `mip.install(PYDEVICES_EXAMPLES + ...)` line in `main.py` to
point at another script under [`lib/examples/`](../../lib/examples/) and update the `import testris`
line at the bottom to match.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ python tools/screenshot.py hello.py
python tools/record.py bouncing_balls 10
```

Output goes to `docs/screenshots/` and `docs/videos/`.
Output goes to [`docs/screenshots/`](docs/screenshots/) and [`docs/videos/`](docs/videos/).

## Build the docs

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/first-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ says why the examples build it themselves.

## Next

Run `lib/examples/pydevices_demo.py` from a clone, then pick another from
Run [`lib/examples/pydevices_demo.py`](../../lib/examples/pydevices_demo.py) from a clone, then pick another from
[`lib/examples/`](https://github.com/PyDevices/pydevices-examples/tree/main/lib/examples).
The [screenshots](../reference/screenshots.md) show what many of them draw.
2 changes: 1 addition & 1 deletion docs/get-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ cd lib
../.venv/bin/python examples/pydevices_demo.py
```

Examples that import helpers from `lib/utils` say so in a `# utils:` comment at
Examples that import helpers from [`lib/utils`](https://github.com/PyDevices/pydevices-examples/tree/main/lib/utils) say so in a `# utils:` comment at
the top. They need `utils/` on the import path:

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/run-in-the-browser.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Run an example in the browser

The [PyScript gallery](https://PyDevices.github.io/pydevices-examples/pyscript/)
runs the real scripts from `lib/examples/` in a modern web browser. Open it,
runs the real scripts from [`lib/examples/`](https://github.com/PyDevices/pydevices-examples/tree/main/lib/examples) in a modern web browser. Open it,
pick an example and it runs; there is nothing to install. The same example
that opens a window on your desktop draws on a canvas in the page.

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/use-a-peter-hinch-gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ application-owned `appdev` app.
| Component | Location | Notes |
|---|---|---|
| `board_config.py` | pydevices' `board_configs/` | Display plus neutral input capabilities |
| *setup module* | `lib/utils/` | `color_setup.py`, `hardware_setup.py`, or `touch_setup.py` — see the table above |
| *setup module* | [`lib/utils/`](https://github.com/PyDevices/pydevices-examples/tree/main/lib/utils) | `color_setup.py`, `hardware_setup.py`, or `touch_setup.py` — see the table above |
| `fetch_ph_gui.py` | `lib/utils/` | `mip` install into `utils/gui/` plus the desktop compatibility patches |
| `displaybuf.py` | `lib/utils/` | The `ssd` framebuffer |
| [`uctypes.py`](https://github.com/PyDevices/pydevices-examples/blob/main/lib/utils/uctypes.py) | `lib/utils/` | CircuitPython shim for the GUIs' `writer.py` |
Expand All @@ -57,7 +57,7 @@ where `<name>` is `micropython-nano-gui`, `micropython-micro-gui`, or

### Examples

Each GUI has a smoke test under `lib/examples/`, and each has a browser gallery
Each GUI has a smoke test under [`lib/examples/`](https://github.com/PyDevices/pydevices-examples/tree/main/lib/examples), and each has a browser gallery
loader that fetches the GUI through its setup module:

| GUI | Example | Gallery |
Expand Down
2 changes: 1 addition & 1 deletion lib/examples/google_photos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ The slideshow interval is `slideshow_s` in the prefs file (default 5).

| Desktop | Microcontroller | Contents |
|---|---|---|
| `~/.gphotos_tokens.json` | `/gphotos_tokens.json` | `client_id`, `client_secret`, `refresh_token` (written by `tools/gphotos_auth.py`; read-only on the device) |
| `~/.gphotos_tokens.json` | `/gphotos_tokens.json` | `client_id`, `client_secret`, `refresh_token` (written by [`tools/gphotos_auth.py`](../../../tools/gphotos_auth.py); read-only on the device) |
| `~/.gphotos_prefs` | `/gphotos_prefs` | JSON: current session, picked items (without their short-lived URLs), `slideshow_s` |
| `~/.gphotos_cache/` | `/gphotos_cache/` | `<hash>_<w>x<h>[c].jpg\|png` thumbnails, at most 48 files |

Expand Down
2 changes: 1 addition & 1 deletion lib/utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@ nano / micro / touch at a time. See
[pdwidgets](https://github.com/PyDevices/pdwidgets),
[palettes](https://github.com/PyDevices/palettes).

Many scripts in `lib/examples/` depend on these modules. They are excluded from
Many scripts in [`lib/examples/`](../examples/) depend on these modules. They are excluded from
the MIP packages — install from GitHub only. Some files are third-party ports
included for convenience; see the file headers for attribution.
4 changes: 2 additions & 2 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,8 @@ the binary-bundled ``imageio-ffmpeg`` Python package.

| Content | Source |
|---------|--------|
| MicroPython stdlib stubs | committed under `tools/typings/` |
| MicroPython stdlib stubs | committed under [`tools/typings/`](typings/) |
| `displaydev` / `appdev` / `multimer` / `events` / `keys` | committed package trees / modules; regenerate with [`../scripts/gen_package_pyi.sh`](../scripts/gen_package_pyi.sh) |
| `lvgl` | committed [`tools/typings/lvgl.pyi`](typings/lvgl.pyi) (from `../lvgl-bindings/generated/lvgl.pyi`) |

Confirm **Python: Select Interpreter** → `.venv/bin/python`. Cursor uses **cursorpyright** with `stubPath` / `typeshedPaths` → `tools/typings` (configured in a local `.vscode/settings.json` when present).
Confirm **Python: Select Interpreter** → `.venv/bin/python`. Cursor uses **cursorpyright** with `stubPath` / `typeshedPaths` → [`tools/typings`](typings/) (configured in a local `.vscode/settings.json` when present).
Loading