Use Workspaces to resolve both CPython and CircuitPython types where necessary (#309)

Co-authored-by: Michael Pham <[email protected]>

Author: nateinaction

.github/workflows/ci.yaml

@@ -40,15 +40,3 @@ jobs:
         uses: SonarSource/[email protected]
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-  archive:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Build
-        run: |
-          make build
-      - name: Archive
-        uses: actions/upload-artifact@v4
-        with:
-          name: proves
-          path: artifacts/proves.zip

.gitignore

@@ -14,3 +14,5 @@ pysquared.egg-info/
 **/*.mpy
 site/
 typeshed/
+*.egg-info
+.ruff_cache/

.pre-commit-config.yaml

@@ -21,8 +21,8 @@ repos:
         entry: '# type:? *ignore'
         language: pygrep
         types: [python]
-        files: ^pysquared/
-        exclude: ^pysquared/beacon\.py|^pysquared/logger\.py|^pysquared/rtc/manager/microcontroller\.py
+        files: ^circuitpython-workspaces/flight-software
+        exclude: ^circuitpython-workspaces/flight-software/src/pysquared/beacon\.py|^circuitpython-workspaces/flight-software/src/pysquared/logger\.py|^circuitpython-workspaces/flight-software/src/pysquared/rtc/manager/microcontroller\.py
 
   - repo: local
     hooks:
@@ -32,7 +32,7 @@ repos:
         entry: '# pyright:? *.*false'
         language: pygrep
         types: [python]
-        files: ^pysquared/
+        files: ^circuitpython-workspaces/flight-software
 
   - repo: https://github.com/codespell-project/codespell
     rev: v2.4.1

.vscode/settings.json

@@ -1,13 +1,8 @@
 {
     "files.eol": "\n",
     "python.testing.pytestArgs": [
-        "tests/unit"
+        "cpython-workspaces/flight-software-unit-tests/src"
     ],
     "python.testing.unittestEnabled": false,
-    "python.testing.pytestEnabled": true,
-    "sonarlint.connectedMode.project": {
-        "connectionId": "proves-kit",
-        "projectKey": "proveskit_circuitpy_flight_software"
-    },
-    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python"
+    "python.testing.pytestEnabled": true
 }

Makefile

@@ -1,5 +1,5 @@
 .PHONY: all
-all: .venv typeshed pre-commit-install
+all: .venv circuitpython-workspaces/typeshed pre-commit-install
 
 .PHONY: help
 help: ## Display this help.
@@ -13,10 +13,10 @@ help: ## Display this help.
 	@$(UV) venv
 	@$(UV) pip install --requirement pyproject.toml
 
-typeshed: ## Install CircuitPython typeshed stubs
+circuitpython-workspaces/typeshed: ## Install CircuitPython typeshed stubs
 	@echo "Installing CircuitPython typeshed stubs..."
 	@$(MAKE) uv
-	@$(UV) pip install circuitpython-typeshed==0.1.0 --target typeshed
+	@$(UV) pip install circuitpython-typeshed==0.1.0 --target circuitpython-workspaces/typeshed
 
 .PHONY: pre-commit-install
 pre-commit-install: uv
@@ -28,54 +28,27 @@ fmt: pre-commit-install ## Lint and format files
 	$(UVX) pre-commit run --all-files
 
 .PHONY: typecheck
-typecheck: .venv typeshed ## Run type check
-	@$(UV) run -m pyright .
+typecheck: .venv circuitpython-workspaces/typeshed ## Run type check
+	@$(UV) run -m pyright --project=circuitpython-workspaces circuitpython-workspaces/
+	@$(UV) run -m pyright --project=cpython-workspaces cpython-workspaces/
 
 .PHONY: test
 test: .venv ## Run tests
-	$(UV) run coverage run --rcfile=pyproject.toml -m pytest tests/unit
+	$(UV) run coverage run --rcfile=pyproject.toml -m pytest cpython-workspaces/flight-software-unit-tests/src
 	@$(UV) run coverage html --rcfile=pyproject.toml > /dev/null
 	@$(UV) run coverage xml --rcfile=pyproject.toml > /dev/null
 
 .PHONY: clean
 clean: ## Remove all gitignored files
 	git clean -dfX
 
-##@ Build
-
-.PHONY: build
-build: uv mpy-cross ## Build the project, store the result in the artifacts directory
-	@echo "Creating artifacts/pysquared"
-	@mkdir -p artifacts/pysquared
-	$(call compile_mpy)
-	$(call rsync_to_dest,.,artifacts/pysquared/)
-	@$(UV) run python -c "import os; [os.remove(os.path.join(root, file)) for root, _, files in os.walk('artifacts/pysquared') for file in files if file.endswith('.py')]"
-	@$(UV) run python -c "import os; [os.remove(os.path.join(root, file)) for root, _, files in os.walk('pysquared') for file in files if file.endswith('.mpy')]"
-	@echo "Creating artifacts/pysquared.zip"
-	@zip -r artifacts/pysquared.zip artifacts/pysquared > /dev/null
-
-define rsync_to_dest
-	@if [ -z "$(1)" ]; then \
-		echo "Issue with Make target, rsync source is not specified. Stopping."; \
-		exit 1; \
-	fi
-
-	@if [ -z "$(2)" ]; then \
-		echo "Issue with Make target, rsync destination is not specified. Stopping."; \
-		exit 1; \
-	fi
-
-	@rsync -avh $(1)/pysquared/* --exclude='requirements.txt' --exclude='__pycache__' $(2) --delete --times --checksum
-endef
-
 ##@ Build Tools
 TOOLS_DIR ?= tools
 $(TOOLS_DIR):
 	mkdir -p $(TOOLS_DIR)
 
 ### Tool Versions
 UV_VERSION ?= 0.8.14
-MPY_CROSS_VERSION ?= 9.0.5
 
 UV_DIR ?= $(TOOLS_DIR)/uv-$(UV_VERSION)
 UV ?= $(UV_DIR)/uv
@@ -85,36 +58,6 @@ uv: $(UV) ## Download uv
 $(UV): $(TOOLS_DIR)
 	@test -s $(UV) || { mkdir -p $(UV_DIR); curl -LsSf https://astral.sh/uv/$(UV_VERSION)/install.sh | UV_INSTALL_DIR=$(UV_DIR) sh > /dev/null; }
 
-UNAME_S := $(shell uname -s)
-UNAME_M := $(shell uname -m)
-
-MPY_S3_PREFIX ?= https://adafruit-circuit-python.s3.amazonaws.com/bin/mpy-cross
-MPY_CROSS ?= $(TOOLS_DIR)/mpy-cross-$(MPY_CROSS_VERSION)
-.PHONY: mpy-cross
-mpy-cross: $(MPY_CROSS) ## Download mpy-cross
-$(MPY_CROSS): $(TOOLS_DIR)
-	@echo "Downloading mpy-cross $(MPY_CROSS_VERSION)..."
-	@mkdir -p $(dir $@)
-ifeq ($(OS),Windows_NT)
-	@curl -LsSf $(MPY_S3_PREFIX)/windows/mpy-cross-windows-$(MPY_CROSS_VERSION).static.exe -o $@
-else
-ifeq ($(UNAME_S),Linux)
-ifeq ($(or $(filter x86_64,$(UNAME_M)),$(filter amd64,$(UNAME_M))),$(UNAME_M))
-	@curl -LsSf $(MPY_S3_PREFIX)/linux-amd64/mpy-cross-linux-amd64-$(MPY_CROSS_VERSION).static -o $@
-	@chmod +x $@
-endif
-else ifeq ($(UNAME_S),Darwin)
-	@curl -LsSf $(MPY_S3_PREFIX)/macos-11/mpy-cross-macos-11-$(MPY_CROSS_VERSION)-universal -o $@
-	@chmod +x $@
-else
-	@echo "Pre-built mpy-cross not available for system: $(UNAME_S)"
-endif
-endif
-
-define compile_mpy
-	@$(UV) run python -c "import os, subprocess; [subprocess.run(['$(MPY_CROSS)', os.path.join(root, file)]) for root, _, files in os.walk('pysquared') for file in files if file.endswith('.py')]" || exit 1
-endef
-
 .PHONY: docs
 docs: uv
 	@$(UV) run --group docs mkdocs serve

README.md

@@ -0,0 +1,29 @@
+[project]
+name = "pysquared-flight-software"
+version = "2.0.0"
+description = "Flight Software for the PROVES Kit"
+requires-python = ">=3.13"
+dependencies = [
+    "adafruit-circuitpython-ina219==3.4.26",
+    "adafruit-circuitpython-asyncio @ git+https://github.com/adafruit/[email protected]",
+    "adafruit-circuitpython-drv2605==1.3.4",
+    "adafruit-circuitpython-lis2mdl==2.1.23",
+    "adafruit-circuitpython-lsm6ds==4.5.13",
+    "adafruit-circuitpython-mcp9808==3.3.24",
+    "adafruit-circuitpython-neopixel==6.3.12",
+    "adafruit-circuitpython-register==1.10.4",
+    "adafruit-circuitpython-rfm==1.0.6",
+    "adafruit-circuitpython-tca9548a @ git+https://github.com/proveskit/[email protected]",
+    "adafruit-circuitpython-ticks==1.1.1",
+    "adafruit-circuitpython-veml7700==2.1.4",
+    "proves-circuitpython-rv3028 @ git+https://github.com/proveskit/[email protected]",
+    "proves-circuitpython-sx126 @ git+https://github.com/proveskit/[email protected]",
+    "proves-circuitpython-sx1280 @ git+https://github.com/proveskit/[email protected]",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["pysquared*"]

circuitpython-workspaces/flight-software/pyproject.toml

@@ -18,10 +18,7 @@
 import time
 from collections import OrderedDict
 
-try:
-    from mocks.circuitpython.microcontroller import Processor
-except ImportError:
-    from microcontroller import Processor
+from microcontroller import Processor
 
 from .hardware.radio.packetizer.packet_manager import PacketManager
 from .logger import Logger