rp2040py 0.1.0b1__tar.gz

rp2040py-0.1.0b1/.github/dependabot.yml

@@ -0,0 +1,29 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "uv" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: "pre-commit"
+    directory: "/"
+    schedule:
+      interval: "weekly"

rp2040py-0.1.0b1/.github/workflows/ci-micropython.yml

@@ -0,0 +1,67 @@
+name: Test MicroPython Releases
+
+on:
+  push:
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ci-micropython-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-micropython:
+    name: Micropython ${{ matrix.micropython_version }} / ${{ matrix.python_runtime }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        micropython_version:
+          - 20210618-v1.16
+          - 20210902-v1.17
+          - 20220117-v1.18
+          - 20220618-v1.19.1
+          - 20230426-v1.20.0
+          - 20231005-v1.21.0
+          - 20260406-v1.28.0
+        python_runtime:
+          - pypy-3.10
+          - cpython-3.10
+          - cpython-3.14
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Download MicroPython ${{ matrix.micropython_version }}
+        run: curl -o micropython.uf2 "https://micropython.org/resources/firmware/RPI_PICO-${VERSION}.uf2"
+        env:
+          VERSION: ${{ matrix.micropython_version }}
+
+      - name: Create filesystem
+        run: uv run python tests/mklittlefs.py littlefs.img tests/micropython/main.py
+
+      - name: Create SPI test filesystem
+        run: uv run python tests/mklittlefs.py littlefs-spi.img tests/micropython/main-spi.py
+
+      - name: Setup Python ${{ matrix.python_runtime }}
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9
+        with:
+          python-version: ${{ matrix.python_runtime }}
+
+      - name: Test MicroPython ${{matrix.python_runtime}}-${{ matrix.micropython_version }}
+        run: timeout 10m uv run --python ${{ matrix.python_runtime }} --no-dev -- python demo/micropython_run.py --image micropython.uf2 --expect-text "Hello, MicroPython!"
+        env:
+          PYTHON_JIT: ${{ matrix.python_runtime == 'cpython-3.14' && '1' || '' }}
+
+      - name: Test MicroPython SPI ${{matrix.python_runtime}}-${{ matrix.micropython_version }}
+        run: timeout 10m uv run --python ${{ matrix.python_runtime }} --no-dev -- python tests/micropython_spi_run.py "hello world" "h" "0123456789abcdef0123456789abcdef0123456789abcdef"
+        env:
+          PYTHON_JIT: ${{ matrix.python_runtime == 'cpython-3.14' && '1' || '' }}

rp2040py-0.1.0b1/.github/workflows/ci-pico-sdk.yml

@@ -0,0 +1,79 @@
+name: Test Pi Pico SDK
+
+on:
+  push:
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ci-pico-sdk-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-pico-sdk:
+    name: Pico SDK ${{ matrix.sdk_version }} / ${{ matrix.python_runtime }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        sdk_version:
+          - 1.2.0
+          - 1.3.1
+          - 1.4.0
+          - 1.5.1
+          - 2.0.0
+          - 2.1.1
+          - 2.2.0
+          - 2.3.0
+        python_runtime:
+          - pypy-3.10
+          - cpython-3.10
+          - cpython-3.14
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Cache Pico SDK
+        id: cache-pico-sdk
+        uses: actions/cache@v6
+        with:
+          path: ~/pico
+          key: ${{ runner.os }}-pico-sdk-${{ matrix.sdk_version }}
+
+      - name: Set up the toolchain
+        if: steps.cache-pico-sdk.outputs.cache-hit != 'true'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake gcc-arm-none-eabi libnewlib-arm-none-eabi build-essential
+
+      - name: Set up the Pi Pico SDK and examples
+        if: steps.cache-pico-sdk.outputs.cache-hit != 'true'
+        run: |
+          mkdir ~/pico
+          cd ~/pico
+          git clone https://github.com/raspberrypi/pico-sdk.git --depth 1 --branch ${SDK_VERSION}
+          cd pico-sdk && git submodule update --init && cd ..
+          git clone https://github.com/raspberrypi/pico-examples.git --depth 1 --branch "sdk-${SDK_VERSION}"
+          cd pico-examples && mkdir build && cd build && cmake .. && make -C hello_world/usb -j4
+        env:
+          SDK_VERSION: ${{ matrix.sdk_version }}
+          PICO_SDK_PATH: ~/pico/pico-sdk
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9
+        with:
+          python-version: "3.10"
+
+      - name: Setup Python ${{ matrix.python_runtime }}
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9
+        with:
+          python-version: ${{ matrix.python_runtime }}
+
+      # CortexM0Core.execute_instruction() is a pure-Python instruction interpreter; CPython is
+      # much slower here than V8 JIT-compiling the equivalent JS in rp2040js, hence the generous
+      # 10-minute timeout - and why this also runs under PyPy and CPython 3.14's experimental JIT
+      # (see docs/PORTING.md#known-differences-from-rp2040js). demo/micropython_run.py has zero
+      # runtime dependencies, so no `uv sync` is needed here.
+      - name: Test "Hello World" example ${{ matrix.python_runtime }}
+        run: timeout 10m uv run --python ${{ matrix.python_runtime }} --no-dev -- python demo/micropython_run.py --image ~/pico/pico-examples/build/hello_world/usb/hello_usb.uf2 --expect-text "Hello, world!"
+        env:
+          PYTHON_JIT: ${{ matrix.python_runtime == 'cpython-3.14' && '1' || '' }}

rp2040py-0.1.0b1/.github/workflows/pre-commit.yml

@@ -0,0 +1,43 @@
+name: Pre-commit
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+  workflow_call:
+
+concurrency:
+  group: pre-commit-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pre-commit:
+    name: pre-commit run --all-files
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9
+        with:
+          python-version: "3.10"
+
+      - name: Install pre-commit
+        run: uv tool install pre-commit
+
+      - name: Run pre-commit
+        run: |
+          pre-commit run --all-files --show-diff-on-failure
+
+      - name: Run tests with coverage
+        run: uv run --group dev pytest --cov=rp2040py --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        if: github.actor != 'dependabot[bot]'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          fail_ci_if_error: false

rp2040py-0.1.0b1/.github/workflows/publish.yml

@@ -0,0 +1,76 @@
+name: Upload Python Package
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Tag to build and publish (e.g. v0.11.0b1)"
+        required: true
+        type: string
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    # Specifying a GitHub environment is optional, but strongly encouraged
+    environment: pypi
+    permissions:
+      # job-level permissions replace (not merge with) the workflow-level block above,
+      # so everything this job needs must be listed here explicitly.
+      contents: write # required to create the GitHub Release
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ inputs.tag || github.ref_name }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9
+
+      - name: Build package
+        run: uv build
+
+      - name: Resolve tag and version
+        id: meta
+        run: |
+          TAG="${{ inputs.tag || github.ref_name }}"
+          VERSION="${TAG#v}"
+          if [[ "$VERSION" =~ (alpha|beta|pre|rc) ]]; then
+            PRERELEASE=true
+          else
+            PRERELEASE=false
+          fi
+          echo "tag=$TAG"               >> $GITHUB_OUTPUT
+          echo "version=$VERSION"       >> $GITHUB_OUTPUT
+          echo "prerelease=$PRERELEASE" >> $GITHUB_OUTPUT
+
+      - name: Extract changelog section
+        id: changelog
+        run: |
+          VERSION=${{ steps.meta.outputs.version }}
+          BODY=$(awk "/^## \[${VERSION}\]/{found=1; next} /^## \[/{found=0} found" CHANGELOG.md | sed '/^[[:space:]]*$/d' | head -50)
+          if [ -z "$BODY" ]; then
+            BODY="See [CHANGELOG.md](https://github.com/${{ github.repository }}/blob/main/CHANGELOG.md) for details."
+          fi
+          echo "body<<EOF" >> $GITHUB_OUTPUT
+          echo "$BODY" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v3
+        with:
+          tag_name: ${{ steps.meta.outputs.tag }}
+          name: ${{ steps.meta.outputs.tag }}
+          body: ${{ steps.changelog.outputs.body }}
+          prerelease: ${{ steps.meta.outputs.prerelease }}
+
+      - name: Publish package to PyPI
+        run: uv publish --check-url https://pypi.org/simple/

rp2040py-0.1.0b1/.gitignore

@@ -0,0 +1,95 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# pyright
+pyrightconfig.json
+
+# claude
+.claude/
+
+# OS
+.DS_Store
+Thumbs.db
+
+**/target
+**/mips*.tar
+**/mips*--glibc*
+**/mips*--musl*
+**/lib.rs:*
+
+# images
+**/*.img
+**/*.uf2

rp2040py-0.1.0b1/.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+default_install_hook_types: [pre-commit]
+default_language_version:
+  python: python3
+
+repos:
+  - repo: local
+    hooks:
+      - id: uv-lock
+        name: uv lock
+        entry: uv
+        args: ["lock", "--upgrade"]
+        language: system
+        pass_filenames: false
+
+      - id: uv-sync
+        name: uv sync before hooks
+        entry: uv
+        args: ["sync"]
+        language: system
+        pass_filenames: false
+
+      - id: uv-mypy
+        name: mypy
+        entry: uv
+        args: ["run", "mypy"]
+        language: system
+        pass_filenames: false
+
+      - id: uv-ruff-check
+        name: ruff lint & fix
+        entry: uv
+        args: ["run", "ruff", "check", "--fix"]
+        language: system
+        pass_filenames: false
+
+      - id: uv-ruff-format
+        name: ruff format
+        entry: uv
+        args: ["run", "ruff", "format"]
+        language: system
+        pass_filenames: false
+
+      - id: uv-pytest
+        name: uv run pytest
+        entry: uv
+        args: ["run", "pytest"]
+        language: system
+        pass_filenames: false

rp2040py-0.1.0b1/.python-version

@@ -0,0 +1 @@
+3.10

rp2040py-0.1.0b1/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0b1] - 2026-07-30
+
+Initial beta release: a complete port of [rp2040js](https://github.com/wokwi/rp2040js) to Python,
+capable of booting real firmware (native `.hex`/`.uf2` images, MicroPython, CircuitPython) end to
+end.
+
+### Added
+- Full RP2040 emulator core: Cortex-M0+ CPU, all peripherals (DMA, PIO, USB, UART, SPI, I2C, ADC,
+  PWM, timers, GPIO, interpolators, etc.), GDB server, and the `demo/`/`tests/` runner scripts
+  needed to actually boot firmware in the emulator.
+- CI workflows (`ci-micropython.yml`, `ci-pico-sdk.yml`) that boot real firmware end to end across
+  a `python_runtime` matrix (CPython 3.10, CPython 3.14 with `PYTHON_JIT=1`, PyPy 3.10), plus
+  `pre-commit.yml` for lint/type/test checks and coverage reporting.
+- `demo/benchmark.py`, a reproducible synthetic and real-firmware-boot benchmark.
+
+### Fixed
+- `tests/mklittlefs.py` now pins the littlefs on-disk format to v2.0 (`disk_version=0x00020000`)
+  regardless of the installed `littlefs-python` version, so generated filesystem images stay
+  mountable by MicroPython releases across the full range tested in CI, not just the newest ones.
+
+### Performance
+- `CortexM0Core.execute_instruction()` now dispatches through a precomputed O(1) table instead of
+  a linear `if`/`elif` scan, alongside several smaller hot-path optimizations (see
+  [docs/PORTING.md](docs/PORTING.md#known-differences-from-rp2040js) for the full breakdown and
+  measurements). Combined effect versus the initial port: real MicroPython + littlefs boot time
+  dropped from minutes to seconds under CPython, and to single-digit seconds under PyPy.
+
+[Unreleased]: https://github.com/o-murphy/rp2040py/compare/v0.1.0b1...HEAD
+[0.1.0b1]: https://github.com/o-murphy/rp2040py/releases/tag/v0.1.0b1

rp2040py-0.1.0b1/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Uri Shaked
+Copyright (c) 2026 Dmytro Yaroshenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.