feat(cli,templates): bundle offline templates; add run --prepare-only

owenthcarey · owenthcarey · commit d9dd821bc182 · 2025-10-09T13:14:34.000-07:00
diff --git a/apps/pythonnative_demo/requirements.txt b/apps/pythonnative_demo/requirements.txt
@@ -0,0 +1 @@
+pythonnative
diff --git a/docs/guides/android.md b/docs/guides/android.md
@@ -1,3 +1,23 @@
 # Android Guide
 
 Basic steps to build and run an Android project generated by `pn`.
+
+## What gets generated
+
+`pn run android` unpacks the bundled Android template (Kotlin + Chaquopy) into `build/android/android_template` and copies your `app/` into the template's `app/src/main/python/app/`.
+
+No network is required for the template itself; the template zip is bundled with the package.
+
+## Run
+
+```bash
+pn run android
+```
+
+Or to only prepare the project without building:
+
+```bash
+pn run android --prepare-only
+```
+
+This will stage files under `build/android/android_template` so you can open it in Android Studio if you prefer.
diff --git a/docs/guides/ios.md b/docs/guides/ios.md
@@ -1,3 +1,23 @@
 # iOS Guide
 
 Basic steps to build and run an iOS project generated by `pn`.
+
+## What gets generated
+
+`pn run ios` unpacks the bundled iOS template (Swift + PythonKit, with optional Rubicon-ObjC) into `build/ios/ios_template` and copies your `app/` under `build/ios/app/` for later integration steps. The template zip is bundled with the package, so no network is required to scaffold.
+
+The default `ViewController.swift` initializes PythonKit, prints the Python version, and attempts to import `rubicon.objc` if present.
+
+## Run / Prepare
+
+```bash
+pn run ios
+```
+
+Or prepare without building:
+
+```bash
+pn run ios --prepare-only
+```
+
+You can then open `build/ios/ios_template/ios_template.xcodeproj` in Xcode.
diff --git a/pyproject.toml b/pyproject.toml
@@ -66,6 +66,13 @@ where = ["src"]
 [tool.setuptools]
 license-files = ["LICENSE*"]
 
+# Ensure template zip files are bundled with the wheel so the CLI can run offline.
+[tool.setuptools.data-files]
+"pythonnative/templates" = [
+  "templates/android_template.zip",
+  "templates/ios_template.zip",
+]
+
 [tool.ruff]
 target-version = "py39"
 line-length = 120
diff --git a/src/pythonnative/cli/pn.py b/src/pythonnative/cli/pn.py
@@ -4,6 +4,7 @@
 import shutil
 import subprocess
 import sys
+import sysconfig
 import zipfile
 from importlib import resources
 
@@ -93,15 +94,39 @@ def _extract_bundled_template(zip_name: str, destination: str) -> None:
     Extract a bundled template zip into the destination directory.
     Tries package resources first; falls back to repo root `templates/` at dev time.
     """
-    # Try to load from installed package resources first
+    # Try to load from installed package resources first (if templates are packaged inside the module)
     try:
-        pkg_templates = resources.files("pythonnative").joinpath("templates")
-        resource_path = str(pkg_templates.joinpath(zip_name))
-        if os.path.exists(resource_path):
-            _extract_zip_to_destination(resource_path, destination)
-            return
+        cand = resources.files("pythonnative").joinpath("templates").joinpath(zip_name)
+        with resources.as_file(cand) as p:
+            resource_path = str(p)
+            if os.path.exists(resource_path):
+                _extract_zip_to_destination(resource_path, destination)
+                return
+    except Exception:
+        # Not packaged inside the module; try data-files installation locations next
+        pass
+
+    # Try sysconfig data dir (where data-files are typically installed)
+    try:
+        data_dir = sysconfig.get_paths().get("data")
+        if data_dir:
+            candidate = os.path.join(data_dir, "pythonnative", "templates", zip_name)
+            if os.path.exists(candidate):
+                _extract_zip_to_destination(candidate, destination)
+                return
+    except Exception:
+        pass
+
+    # Try site-packages purelib/platlib (some environments place data files here)
+    try:
+        purelib = sysconfig.get_paths().get("purelib")
+        platlib = sysconfig.get_paths().get("platlib")
+        for base in filter(None, [purelib, platlib]):
+            candidate = os.path.join(base, "pythonnative", "templates", zip_name)
+            if os.path.exists(candidate):
+                _extract_zip_to_destination(candidate, destination)
+                return
     except Exception:
-        # Fall back to repo layout
         pass
 
     # Fallback: use repository-level templates directory
@@ -143,6 +168,7 @@ def run_project(args: argparse.Namespace) -> None:
     """
     # Determine the platform
     platform: str = args.platform
+    prepare_only: bool = getattr(args, "prepare_only", False)
 
     # Define the build directory
     build_dir: str = os.path.join(os.getcwd(), "build", platform)
@@ -171,11 +197,17 @@ def run_project(args: argparse.Namespace) -> None:
     shutil.copytree(src_dir, dest_dir, dirs_exist_ok=True)
 
     # Install any necessary Python packages into the project environment
-    requirements_path = os.path.join(os.getcwd(), "requirements.txt")
-    if os.path.exists(requirements_path):
-        subprocess.run([sys.executable, "-m", "pip", "install", "-r", requirements_path], check=False)
+    # Skip installation during prepare-only to avoid network access and speed up scaffolding
+    if not prepare_only:
+        requirements_path = os.path.join(os.getcwd(), "requirements.txt")
+        if os.path.exists(requirements_path):
+            subprocess.run([sys.executable, "-m", "pip", "install", "-r", requirements_path], check=False)
 
     # Run the project
+    if prepare_only:
+        print("Prepared project in build/ without building (prepare-only).")
+        return
+
     if platform == "android":
         # Change to the Android project directory
         android_project_dir: str = os.path.join(build_dir, "android_template")
@@ -261,6 +293,11 @@ def main() -> None:
     # Create a new command 'run' that calls run_project
     parser_run = subparsers.add_parser("run")
     parser_run.add_argument("platform", choices=["android", "ios"])
+    parser_run.add_argument(
+        "--prepare-only",
+        action="store_true",
+        help="Extract templates and stage app without building",
+    )
     parser_run.set_defaults(func=run_project)
 
     # Create a new command 'clean' that calls clean_project
diff --git a/templates/ios_template/ios_template/ViewController.swift b/templates/ios_template/ios_template/ViewController.swift
@@ -6,12 +6,25 @@
 //
 
 import UIKit
+import PythonKit
 
 class ViewController: UIViewController {
 
     override func viewDidLoad() {
         super.viewDidLoad()
-        // Do any additional setup after loading the view.
+        // Minimal PythonKit bootstrap: print Python version and attempt to import Rubicon.
+        let sys = Python.import("sys")
+        print("Python Version: \(sys.version_info.major).\(sys.version_info.minor)")
+        print("Python Path: \(sys.path)")
+
+        // Try to import Rubicon-ObjC if available. Safe no-op if not present.
+        do {
+            let rubiconObjC = try Python.attemptImport("rubicon.objc")
+            let ObjCClass = rubiconObjC.ObjCClass
+            print("Rubicon available: \(ObjCClass)")
+        } catch {
+            print("Rubicon not available; continuing without it.")
+        }
     }
 
 
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -32,3 +32,23 @@ def test_cli_init_and_clean():
         assert not os.path.exists(os.path.join(tmpdir, "build"))
     finally:
         shutil.rmtree(tmpdir, ignore_errors=True)
+
+
+def test_cli_run_prepare_only_android_and_ios():
+    tmpdir = tempfile.mkdtemp(prefix="pn_cli_test_")
+    try:
+        # init to create app scaffold
+        result = run_pn(["init", "MyApp"], tmpdir)
+        assert result.returncode == 0, result.stderr
+
+        # prepare-only android
+        result = run_pn(["run", "android", "--prepare-only"], tmpdir)
+        assert result.returncode == 0, result.stderr
+        assert os.path.isdir(os.path.join(tmpdir, "build", "android", "android_template"))
+
+        # prepare-only ios
+        result = run_pn(["run", "ios", "--prepare-only"], tmpdir)
+        assert result.returncode == 0, result.stderr
+        assert os.path.isdir(os.path.join(tmpdir, "build", "ios", "ios_template"))
+    finally:
+        shutil.rmtree(tmpdir, ignore_errors=True)
