simulate-circuitpython-nativesim 1.0.0__tar.gz

simulate_circuitpython_nativesim-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: 2024 Alec Delaney
+# SPDX-License-Identifier: MIT
+
+name: Run publish-specific workflows
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v6
+        with:
+          submodules: true
+      - name: Install Python
+        uses: actions/setup-python@v6
+        with:
+            python-version: "3.X"
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip
+          pip install build
+      - name: Update package version to ${{ github.event.release.tag_name }}
+        run: |
+          echo "${{ github.event.release.tag_name }}" > VERSION
+      - name: Build the package
+        run: |
+          python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

simulate_circuitpython_nativesim-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
+# SPDX-License-Identifier: Unlicense
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.5
+    hooks:
+      - id: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v6.2.0
+    hooks:
+      - id: reuse

simulate_circuitpython_nativesim-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alec Delaney
+
+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.

simulate_circuitpython_nativesim-1.0.0/LICENSES/MIT.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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.

simulate_circuitpython_nativesim-1.0.0/LICENSES/Unlicense.txt

@@ -0,0 +1,10 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
+
+In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

simulate_circuitpython_nativesim-1.0.0/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: simulate-circuitpython-nativesim
+Version: 1.0.0
+Summary: Simulate CircuitPython using Zephyr simulator
+Author-email: Alec Delaney <tekktrik@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/tekktrik/simulate-circuitpython
+Keywords: adafruit,blinka,circuitpython,micropython,zephyr,simulate,simulator
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: System :: Hardware
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pre-commit~=4.5; extra == "dev"
+Dynamic: license-file
+
+# simulate-circuitpython
+Simulate CircuitPython using Zephyr simulator
+
+## Inputs
+
+| Argument Name | Description | Default | Notes |
+| --- | --- | --- | --- |
+| ``version`` | Version of CircuitPython to simulate | ``main`` | Must be a version that supports the Zephyr OS native sim |
+| ``circuitpy`` | Filepath to file or folder of files to add to the simualted CIRCUITPY | N/A (required) |  |
+| ``circuitpython-folder`` | Folder name to use for the CircuitPython checkout | ``cpysim`` | Change this if it conflicts with another file/folder |
+
+## Outputs
+
+| Argument Name | Description | Notes |
+| --- | --- | --- |
+| ``output-text`` | The text output from the simulator |  |
+
+## License
+
+This library is available under an MIT license.

simulate_circuitpython_nativesim-1.0.0/README.md

@@ -0,0 +1,20 @@
+# simulate-circuitpython
+Simulate CircuitPython using Zephyr simulator
+
+## Inputs
+
+| Argument Name | Description | Default | Notes |
+| --- | --- | --- | --- |
+| ``version`` | Version of CircuitPython to simulate | ``main`` | Must be a version that supports the Zephyr OS native sim |
+| ``circuitpy`` | Filepath to file or folder of files to add to the simualted CIRCUITPY | N/A (required) |  |
+| ``circuitpython-folder`` | Folder name to use for the CircuitPython checkout | ``cpysim`` | Change this if it conflicts with another file/folder |
+
+## Outputs
+
+| Argument Name | Description | Notes |
+| --- | --- | --- |
+| ``output-text`` | The text output from the simulator |  |
+
+## License
+
+This library is available under an MIT license.

simulate_circuitpython_nativesim-1.0.0/README.md.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: 2026 Alec Delaney
+SPDX-License-Identifier: MIT

simulate_circuitpython_nativesim-1.0.0/VERSION

@@ -0,0 +1 @@
+v1.0.0

simulate_circuitpython_nativesim-1.0.0/VERSION.license

@@ -0,0 +1,2 @@
+SPDX-FileCopyrightText: 2024 Alec Delaney, for Adafruit Industries
+SPDX-License-Identifier: MIT

simulate_circuitpython_nativesim-1.0.0/action.yml

@@ -0,0 +1,140 @@
+# SPDX-FileCopyrightText: 2026 Alec Delaney
+# SPDX-License-Identifier: MIT
+
+name: 'Simulate CircuitPython'
+description: 'Simulate CircuitPython using Zephyr simulator'
+inputs:
+  version:
+    description: 'Version of CircuitPython to simulate'
+    required: true
+    default: main
+  circuitpy:
+    description: 'Filepath to file or folder of files to add to the simualted CIRCUITPY'
+    required: true
+  circuitpython-folder:
+    description: 'Folder name to use for the CircuitPython checkout'
+    required: true
+    default: 'cpysim'
+outputs:
+  output-text:
+    description: 'The text output from the simulator'
+    value: ${{ steps.run-sim.outputs.simout }}
+runs:
+  using: "composite"
+  steps:
+    - name: Setup Python 3.12
+      uses: actions/setup-python@v6
+      with:
+        python-version: 3.12
+    - name: Checkout CircuitPython repository
+      uses: actions/checkout@v6
+      with:
+        repository: adafruit/circuitpython
+        path: ${{ inputs.circuitpython-folder }}
+        ref: ${{ inputs.version }}
+        fetch-depth: 0
+    - name: Determine cache key
+      id: cache-key
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}
+      run: |
+        if [[ "${{ inputs.version }}" == "main" ]]; then
+          GITREV=$(git rev-parse --short HEAD)
+          CACHE_KEY="$GITREV-zephyr-cache"
+        else
+          CACHE_KEY="${{ inputs.version }}-zephyr-cache"
+        fi
+        echo "CACHE_KEY=$CACHE_KEY" >> $GITHUB_OUTPUT
+    - name: Install system dependencies
+      shell: bash
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y \
+          libusb-1.0-0-dev \
+          libudev-dev \
+          mtools \
+          protobuf-compiler \
+          dosfstools \
+          gcc-multilib \
+          g++-multilib
+    - name: Cache firmware build
+      id: cache-firmware
+      uses: actions/cache@v5
+      with:
+        path: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp/build-native_native_sim/firmware.exe
+        key: ${{ steps.cache-key.outputs.CACHE_KEY }}
+    - name: Fetch submodules
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      if: steps.cache-firmware.outputs.cache-hit != 'true'
+      run: make fetch-port-submodules
+    - name: Install CircuitPython dev dependencies
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}
+      if: steps.cache-firmware.outputs.cache-hit != 'true'
+      run: pip install -r requirements-dev.txt
+    - name: Install west
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      if: steps.cache-firmware.outputs.cache-hit != 'true'
+      run: pip install west
+    - name: Create west workspace
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      if: steps.cache-firmware.outputs.cache-hit != 'true'
+      run: west init -l zephyr-config
+    - name: Update west project
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      if: steps.cache-firmware.outputs.cache-hit != 'true'
+      run: west update
+    - name: Export Zephyr installation
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      if: steps.cache-firmware.outputs.cache-hit != 'true'
+      run: west zephyr-export
+    - name: Install Zephyr script dependencies
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      if: steps.cache-firmware.outputs.cache-hit != 'true'
+      run: |
+        pip install -r zephyr/scripts/requirements.txt
+        pip install protobuf grpcio-tools
+    - name: Install Zephyr SDK
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      if: steps.cache-firmware.outputs.cache-hit != 'true'
+      run: west sdk install
+    - name: Make the firmware
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      if: steps.cache-firmware.outputs.cache-hit != 'true'
+      run: make BOARD=native_native_sim BUILD=build-native_native_sim build-native_native_sim/firmware.exe
+    - name: Create flash space
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      run: |
+        truncate -s 2M build-native_native_sim/flash.bin
+        mformat -i build-native_native_sim/flash.bin ::
+    - name: Create CIRCUITPY folder
+      shell: bash
+      run: |
+        python ${{ github.action_path }}/scripts/prepare.py ${{ inputs.circuitpy }} ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+    - name: Add files to flash
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      run: mcopy -s -i build-native_native_sim/flash.bin CIRCUITPY/* ::;
+    - name: Install simulator command
+      shell: bash
+      run: pipx install ${{ github.action_path }}
+    - name: Run simulator script
+      id: run-sim
+      shell: bash
+      working-directory: ${{ inputs.circuitpython-folder }}/ports/zephyr-cp
+      run: |
+        SIM_OUTPUT=$(simulate-circuitpython)
+        {
+          echo "simout<<EOF"
+          echo "$SIM_OUTPUT"
+          echo "EOF"
+        } >> "$GITHUB_OUTPUT"

simulate_circuitpython_nativesim-1.0.0/circuitpy_sim.py

@@ -0,0 +1,70 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 Scott Shawcroft for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2026 Alec Delaney
+#
+# SPDX-License-Identifier: MIT
+
+"""Slim and simple version of the CircuitPython Zephyr test infrastructure."""
+
+import subprocess
+
+
+class Simualtor:
+    """Zephyr OS native sim wrapper."""
+
+    def __init__(self, timeout: int = 5) -> None:
+        """Intialize the simulator."""
+        self.simproc: subprocess.Popen | None = None
+        self.cmd = [
+            "build-native_native_sim/firmware.exe",
+            "--flash=build-native_native_sim/flash.bin",
+            "-rt",
+            "-uart_stdinout",
+            f"-stop_at={timeout}",
+        ]
+
+    def simulate(self) -> str:
+        """Simulate using the native sim firmware."""
+        self.simproc = subprocess.Popen(
+            self.cmd,
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=None,
+        )
+
+        if self.simproc.stdout is None:
+            raise RuntimeError("Failed to capture simulator output")
+
+        recording: bool | None = None
+        recorded = ""
+
+        while self.simproc.poll() is None:
+            pass
+
+        output: str = self.simproc.stdout.read().decode()
+        for line in output.split("\n"):
+            encoded = line.encode()
+            if not line:
+                continue
+            if (
+                encoded.strip() == b"\x1b[2K\x1b[0Gcode.py output:"
+                and recording is None
+            ):
+                recording = True
+            elif line.strip() == "Code done running." and recording:
+                recording = False
+                break
+            elif recording:
+                recorded += line + "\n"
+
+        return recorded.strip()
+
+
+def simulate_circuitpython() -> None:
+    """Simulate CircuitPython using a simulator."""
+    simulator = Simualtor()
+    result = simulator.simulate()
+    print(result)
+
+
+if __name__ == "__main__":
+    simulate_circuitpython()

simulate_circuitpython_nativesim-1.0.0/pyproject.toml

@@ -0,0 +1,54 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 Alec Delaney
+# SPDX-License-Identifier: MIT
+
+[build-system]
+requires = [
+    "setuptools",
+    "wheel",
+    "setuptools-scm",
+]
+
+[project]
+name = "simulate-circuitpython-nativesim"
+description = "Simulate CircuitPython using Zephyr simulator"
+readme = "README.md"
+authors = [
+    {name = "Alec Delaney", email = "tekktrik@gmail.com"}
+]
+urls = {Homepage = "https://github.com/tekktrik/simulate-circuitpython"}
+keywords = [
+    "adafruit",
+    "blinka",
+    "circuitpython",
+    "micropython",
+    "zephyr",
+    "simulate",
+    "simulator",
+]
+license = "MIT"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: System :: Hardware",
+    "Programming Language :: Python :: 3",
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit~=4.5",
+]
+
+[project.scripts]
+simulate-circuitpython = "circuitpy_sim:simulate_circuitpython"
+
+[tool.setuptools]
+py-modules = ["circuitpy_sim"]
+
+[tool.setuptools.dynamic.version]
+file = "VERSION"
+
+[tool.ruff.lint]
+select = ["D", "PL", "I"]
+ignore = ["D213", "D203"]

simulate_circuitpython_nativesim-1.0.0/scripts/prepare.py

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 Alec Delaney
+# SPDX-License-Identifier: MIT
+
+"""Prepare the CIRCUITPY drive."""
+
+import pathlib
+import shutil
+import sys
+
+
+def prepare():
+    """Prepare the CIRCUITPY drive folder."""
+    src = pathlib.Path(sys.argv[1])
+    dst = pathlib.Path(sys.argv[2])
+
+    if not src.exists():
+        print(f"Filepath {src.absolute()} does not exist")
+        sys.exit(1)
+
+    circuitpy = dst / "CIRCUITPY"
+    circuitpy.mkdir()
+
+    if src.is_file():
+        print(f"Copying file {src} to {circuitpy}")
+        shutil.copy(src, circuitpy)
+    else:
+        print(f"Copying folder {src} to {circuitpy}")
+        shutil.copytree(src, circuitpy, dirs_exist_ok=True)
+
+
+if __name__ == "__main__":
+    prepare()

simulate_circuitpython_nativesim-1.0.0/scripts/simulate.py

@@ -0,0 +1,8 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 Alec Delaney
+# SPDX-License-Identifier: MIT
+
+"""CircuitPython simulator script."""
+
+import circuitpy_sim
+
+circuitpy_sim.simulate_circuitpython()

simulate_circuitpython_nativesim-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

simulate_circuitpython_nativesim-1.0.0/simulate_circuitpython_nativesim.egg-info/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: simulate-circuitpython-nativesim
+Version: 1.0.0
+Summary: Simulate CircuitPython using Zephyr simulator
+Author-email: Alec Delaney <tekktrik@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/tekktrik/simulate-circuitpython
+Keywords: adafruit,blinka,circuitpython,micropython,zephyr,simulate,simulator
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: System :: Hardware
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pre-commit~=4.5; extra == "dev"
+Dynamic: license-file
+
+# simulate-circuitpython
+Simulate CircuitPython using Zephyr simulator
+
+## Inputs
+
+| Argument Name | Description | Default | Notes |
+| --- | --- | --- | --- |
+| ``version`` | Version of CircuitPython to simulate | ``main`` | Must be a version that supports the Zephyr OS native sim |
+| ``circuitpy`` | Filepath to file or folder of files to add to the simualted CIRCUITPY | N/A (required) |  |
+| ``circuitpython-folder`` | Folder name to use for the CircuitPython checkout | ``cpysim`` | Change this if it conflicts with another file/folder |
+
+## Outputs
+
+| Argument Name | Description | Notes |
+| --- | --- | --- |
+| ``output-text`` | The text output from the simulator |  |
+
+## License
+
+This library is available under an MIT license.

simulate_circuitpython_nativesim-1.0.0/simulate_circuitpython_nativesim.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+.pre-commit-config.yaml
+LICENSE
+README.md
+README.md.license
+VERSION
+VERSION.license
+action.yml
+circuitpy_sim.py
+pyproject.toml
+.github/workflows/publish.yml
+LICENSES/MIT.txt
+LICENSES/Unlicense.txt
+scripts/prepare.py
+scripts/simulate.py
+simulate_circuitpython_nativesim.egg-info/PKG-INFO
+simulate_circuitpython_nativesim.egg-info/SOURCES.txt
+simulate_circuitpython_nativesim.egg-info/dependency_links.txt
+simulate_circuitpython_nativesim.egg-info/entry_points.txt
+simulate_circuitpython_nativesim.egg-info/requires.txt
+simulate_circuitpython_nativesim.egg-info/top_level.txt

simulate_circuitpython_nativesim-1.0.0/simulate_circuitpython_nativesim.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

simulate_circuitpython_nativesim-1.0.0/simulate_circuitpython_nativesim.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+simulate-circuitpython = circuitpy_sim:simulate_circuitpython

simulate_circuitpython_nativesim-1.0.0/simulate_circuitpython_nativesim.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[dev]
+pre-commit~=4.5

simulate_circuitpython_nativesim-1.0.0/simulate_circuitpython_nativesim.egg-info/top_level.txt

@@ -0,0 +1 @@
+circuitpy_sim