Add MicroPython Board Comparison Tool - libcst-Based Multi-View Web Explorer with Shareable Links, Multi-Version Support, and CI/CD Testing

.github/workflows/update_board_comparison.yml

@@ -0,0 +1,48 @@
+name: Update Board Comparison Database
+
+on:
+  schedule:
+    # Run every Sunday at 2 AM UTC
+    - cron: '0 2 * * 0'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'MicroPython version to process (e.g., v1_26_0)'
+        required: false
+        default: 'v1_26_0'
+
+jobs:
+  update-database:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          pip install pydantic
+
+      - name: Build database
+        run: |
+          cd tools/board_compare
+          VERSION=${{ github.event.inputs.version || 'v1_26_0' }}
+          python build_database.py \
+            --version $VERSION \
+            --db board_comparison.db \
+            --json frontend/board_comparison.json
+
+      - name: Commit and push if changed
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git add tools/board_compare/board_comparison.db
+          git add tools/board_compare/frontend/board_comparison.json
+          git diff --quiet && git diff --staged --quiet || (git commit -m "Update board comparison database [automated]" && git push)

.gitignore

@@ -57,4 +57,8 @@ publish/micropython-stdlib-stubs_100b1
 
 # no test lock files
 **/*_lock.file
-tests/doc_test/micropython/
+tests/doc_test/micropython/
+
+# board comparison database files (generated)
+tools/board_compare/*.db
+tools/board_compare/*.db-journal

README.md

@@ -33,6 +33,24 @@ Curious about which versions, ports, and boards are covered? Check out the [onli
 
 For a comprehensive overview of all stubs, dive into the documentation on [the documentation on read the docs](https://micropython-stubs.readthedocs.io/en/main/firmware_grp.html).
 
+## Board Comparison Tool
+
+Compare MicroPython APIs across different boards and versions! The board comparison tool allows you to:
+
+- **Compare modules** available on different boards (ESP32, RP2, STM32, etc.)
+- **Identify unique APIs** specific to certain boards
+- **Explore common modules** shared across platforms
+- **View detailed information** about classes, methods, and parameters (stored in SQLite database)
+
+The tool consists of:
+- A Python-based stub scanner that extracts API information from `.pyi` files
+- A SQLite database with normalized board/module/class/method data
+- A web-based viewer for easy comparison (available in PyScript and vanilla JavaScript versions)
+
+👉 **Try it out:** See `tools/board_compare/README.md` for usage instructions
+
+The database is automatically updated weekly via GitHub Actions.
+
 ## Sponsoring
 
 In order to build accurate stubs I need access to a board to flash it with a specific version of MicroPython and run part of the stubbing software (createsubs.py) on the board.