chore(scripts): add check.sh to run ci.yml checks locally

owenthcarey · owenthcarey · commit 6bcb874fe287 · 2026-05-13T13:12:53.000-07:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,21 +7,14 @@ Thanks for your interest in contributing. This repository contains the PythonNat
 Development uses Python ≥ 3.10.
 
 ```bash
-# create and activate a venv (recommended)
-python3 -m venv .venv && source .venv/bin/activate
+# one-shot: creates .venv, syncs CI deps, runs every CI check
+# (requires uv: https://docs.astral.sh/uv/getting-started/installation/)
+./scripts/check.sh
 
-# install dev tools (lint/format/test)
-pip install -e ".[dev]"
-
-# install library (editable) and CLI
-pip install -e .
-
-# run tests
+# Run individual steps if you only want one
 pytest -q
-
-# format and lint
-black src examples tests || true
 ruff check .
+black src examples tests
 ```
 
 Common library and CLI entry points:
@@ -63,6 +56,7 @@ cd examples/hello-world && pn run android
 Common commands:
 
 ```bash
+./scripts/check.sh            # run all CI checks (mirrors ci.yml)
 pytest -q                     # run tests
 ruff check .                  # lint
 black src examples tests      # format
@@ -127,6 +121,7 @@ Recommended scopes (choose the smallest, most accurate unit; prefer module/direc
   - `mkdocs` – documentation site (MkDocs/Material) configuration and content under `docs/`
   - `pyproject` – `pyproject.toml` packaging/build metadata
   - `repo` – repository metadata and top‑level files (`README.md`, `CONTRIBUTING.md`, `.gitignore`, licenses)
+  - `scripts` – developer scripts under `scripts/` (e.g., `check.sh`)
   - `templates` – Android/iOS project templates under `src/pythonnative/templates/`
   - `tests` – unit/integration/E2E tests under `tests/`
   - `workflows` – CI pipelines under `.github/workflows/`
diff --git a/scripts/check.sh b/scripts/check.sh
@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+# Run the same checks as .github/workflows/ci.yml locally, in the same order.
+# Stops at the first failure. If this script is green, CI should be green too.
+#
+# Uses uv to manage the project venv and CI dependencies. Install uv first:
+#   curl -LsSf https://astral.sh/uv/install.sh | sh
+#
+# Usage:
+#   ./scripts/check.sh
+
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ROOT_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
+cd "$ROOT_DIR"
+
+if ! command -v uv > /dev/null; then
+  echo "Error: 'uv' is not installed." >&2
+  echo "Install: https://docs.astral.sh/uv/getting-started/installation/" >&2
+  exit 1
+fi
+
+if [[ ! -x ".venv/bin/python" ]]; then
+  printf "\n==> Creating .venv (uv venv --seed)\n"
+  uv venv --seed
+fi
+
+printf "\n==> Syncing CI dependencies\n"
+uv pip install --python .venv/bin/python -e ".[ci]" build
+
+PY=".venv/bin/python"
+
+step() {
+  printf "\n==> %s\n" "$1"
+}
+
+step "Lint (Ruff)"
+"$PY" -m ruff check .
+
+step "Format check (Black)"
+"$PY" -m black --check src examples tests
+
+step "Type check (MyPy)"
+"$PY" -m mypy --install-types --non-interactive
+
+step "Build package (sdist + wheel)"
+"$PY" -m build
+
+step "Run tests (pytest)"
+"$PY" -m pytest -q
+
+printf "\nAll CI checks passed.\n"
