afterpython 0.3.10__tar.gz → 0.3.12__tar.gz

{afterpython-0.3.10 → afterpython-0.3.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: afterpython
-Version: 0.3.10
+Version: 0.3.12
 Summary: CLI tool to streamline Python package maintenance and generate a dedicated project website
 Keywords: package-maintenance,project-website,static-site-generator,developer-tools,documentation,cli-tool,ci/cd,mystmd,semantic-release,python-packaging
 Author: Stephen Yau
@@ -23,7 +23,7 @@ Requires-Dist: gitpython>=3.1.50
 Requires-Dist: python-dotenv>=1.2.2
 Requires-Dist: pyproject-metadata>=0.11.0
 Requires-Dist: jupytext>=1.19.2
-Requires-Dist: mystmd>=1.9.0
+Requires-Dist: mystmd>=1.9.1
 Requires-Dist: pdoc>=16.0.0
 Requires-Dist: ruff>=0.15.12
 Requires-Dist: pre-commit>=4.6.0

{afterpython-0.3.10 → afterpython-0.3.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "afterpython"
-version = "0.3.10"
+version = "0.3.12"
 description = "CLI tool to streamline Python package maintenance and generate a dedicated project website"
 license = "Apache-2.0"
 authors = [
@@ -43,7 +43,7 @@ dependencies = [
     "pyproject-metadata>=0.11.0",
     "jupytext>=1.19.2",
     # "jinja2>=3.1.6",
-    "mystmd>=1.9.0",
+    "mystmd>=1.9.1",
     "pdoc>=16.0.0",
     "ruff>=0.15.12",
     "pre-commit>=4.6.0",

{afterpython-0.3.10 → afterpython-0.3.12}/src/afterpython/builders/marimo_notebook.py

@@ -41,15 +41,33 @@ def is_marimo_notebook(path: Path) -> bool:
     return "__generated_with" in head and "marimo.App(" in head
 
 
-def _export_marimo(source: Path, output_html: Path, mode: MarimoExportMode):
+def _export_marimo(
+    source: Path,
+    output_html: Path,
+    mode: MarimoExportMode,
+    execute: bool = False,
+):
     """Run `marimo export` to produce HTML at `output_html`."""
     output_html.parent.mkdir(parents=True, exist_ok=True)
     subcommand = "html-wasm" if mode == "wasm" else "html"
-    cmd = ["marimo", "export", subcommand, str(source), "-o", str(output_html)]
+    cmd = [
+        "marimo",
+        "export",
+        subcommand,
+        str(source),
+        "-o",
+        str(output_html),
+        "--sandbox",
+        "--force",
+    ]
     # WASM-only flag: --mode edit shows code cells (interactive). Without it,
     # marimo's html-wasm subcommand defaults to "run" which hides them.
+    # --sandbox auto-answers marimo's interactive "Run in a sandboxed venv?"
+    # prompt; non-interactive builds (CI, `ap build`) would otherwise hang.
     if mode == "wasm":
         cmd += ["--mode", "edit"]
+        if execute:
+            cmd += ["--execute"]
     result = subprocess.run(cmd, check=False)
     if result.returncode != 0:
         raise click.ClickException(f"marimo export failed for {source}")
@@ -85,6 +103,7 @@ def build_marimo_notebook(
     output_html: Path,
     content_path: Path,
     mode: MarimoExportMode = "wasm",
+    execute: bool = False,
 ):
     """Build a single marimo notebook to HTML and inject the molab badge.
 
@@ -104,7 +123,7 @@ def build_marimo_notebook(
         return
 
     click.echo(f"Building marimo notebook {source.name} (mode={mode})...")
-    _export_marimo(source, output_html, mode)
+    _export_marimo(source, output_html, mode, execute=execute)
 
     # WASM mode runs the notebook in-browser via Pyodide, so molab (a remote
     # runtime) is redundant. Skip the badge.
@@ -136,9 +155,14 @@ def build_marimo_readme(mode: MarimoExportMode = "wasm"):
     Skips silently if README.py is absent or isn't a marimo notebook so users
     who keep only README.md aren't penalized.
     """
+    from afterpython._io.toml import _from_tomlkit
+    from afterpython.tools._afterpython import read_afterpython
+
     readme_path = ap.paths.afterpython_path / "README.py"
     if not readme_path.exists():
         return
     output_html = ap.paths.build_path / "readme_py" / "readme_py.html"
     content_path = Path("README.py")
-    build_marimo_notebook(readme_path, output_html, content_path, mode)
+    website = _from_tomlkit(read_afterpython().get("website", {}))
+    execute = bool(website.get("execute_readme_py", False))
+    build_marimo_notebook(readme_path, output_html, content_path, mode, execute=execute)

{afterpython-0.3.10 → afterpython-0.3.12}/src/afterpython/cli/commands/init.py

@@ -43,6 +43,16 @@ def init_py_typed():
     click.echo(f"Created {py_typed_path}")
 
 
+def _preflight_init(skip_website: bool) -> None:
+    """Validate external prerequisites before any filesystem writes, so a
+    failure aborts cleanly instead of leaving a half-initialized project."""
+    if not skip_website:
+        from afterpython.tools.myst import ensure_pnpm_11
+        from afterpython.utils import find_node_env
+
+        ensure_pnpm_11(find_node_env())
+
+
 @click.group(invoke_without_command=True)
 @click.option(
     "--yes",
@@ -70,48 +80,60 @@ def init(ctx, yes, skip_website: bool):
     from afterpython.tools.pre_commit import init_pre_commit
     from afterpython.tools.pyproject import init_pyproject
 
+    _preflight_init(skip_website)
+
     paths = ctx.obj["paths"]
     click.echo("Initializing afterpython...")
     afterpython_path = paths.afterpython_path
     static_path = paths.static_path
 
-    afterpython_path.mkdir(parents=True, exist_ok=True)
-    static_path.mkdir(parents=True, exist_ok=True)
-
-    init_pyproject()
-
-    init_afterpython()
-
-    if not skip_website:
-        subprocess.run(["ap", "init", "website"])
-
-    # TODO: add type checking related stuff here
-    init_py_typed()
-
-    create_workflow("ci")
-
-    if yes or click.confirm(
-        f"\nCreate .pre-commit-config.yaml in {afterpython_path}?", default=True
-    ):
-        init_pre_commit()
-
-    if yes or click.confirm(f"\nCreate ruff.toml in {afterpython_path}?", default=True):
-        init_ruff_toml()
-
-    if yes or click.confirm(
-        f"\nCreate commitizen configuration (cz.toml) in {afterpython_path} "
-        f"and release workflow in .github/workflows/release.yml?",
-        default=True,
-    ):
-        init_commitizen()
-        create_workflow("release")
-
-    if yes or click.confirm(
-        "\nCreate Dependabot configuration (.github/dependabot.yml) "
-        "to auto-update GitHub Actions versions?",
-        default=True,
-    ):
-        create_dependabot()
+    try:
+        afterpython_path.mkdir(parents=True, exist_ok=True)
+        static_path.mkdir(parents=True, exist_ok=True)
+
+        init_pyproject()
+
+        init_afterpython()
+
+        if not skip_website:
+            # check=True so a failure inside `ap init website` aborts the parent
+            # run instead of silently continuing to write more files.
+            subprocess.run(["ap", "init", "website"], check=True)
+
+        # TODO: add type checking related stuff here
+        init_py_typed()
+
+        create_workflow("ci")
+
+        if yes or click.confirm(
+            f"\nCreate .pre-commit-config.yaml in {afterpython_path}?", default=True
+        ):
+            init_pre_commit()
+
+        if yes or click.confirm(
+            f"\nCreate ruff.toml in {afterpython_path}?", default=True
+        ):
+            init_ruff_toml()
+
+        if yes or click.confirm(
+            f"\nCreate commitizen configuration (cz.toml) in {afterpython_path} "
+            f"and release workflow in .github/workflows/release.yml?",
+            default=True,
+        ):
+            init_commitizen()
+            create_workflow("release")
+
+        if yes or click.confirm(
+            "\nCreate Dependabot configuration (.github/dependabot.yml) "
+            "to auto-update GitHub Actions versions?",
+            default=True,
+        ):
+            create_dependabot()
+    except BaseException:
+        if afterpython_path.exists():
+            click.echo(f"ap init failed — removing {afterpython_path}", err=True)
+            shutil.rmtree(afterpython_path, ignore_errors=True)
+        raise
 
 
 @init.command("website")
@@ -122,10 +144,18 @@ def init_website_subcommand():
     the website to an existing AfterPython project.
     """
     from afterpython.tools.github_actions import create_workflow
-    from afterpython.tools.myst import init_myst
+    from afterpython.tools.myst import ensure_pnpm_11, init_myst
+    from afterpython.utils import find_node_env
+
+    # Pre-flight: same rationale as `ap init` — guard the standalone entry too,
+    # since this subcommand can be invoked directly via `ap init website`.
+    ensure_pnpm_11(find_node_env())
 
     init_faq()
     init_myst()
     click.echo(f"Initializing project website template in {ap.paths.website_path}...")
-    subprocess.run(["ap", "update", "website"])
+    # check=True so a network/pnpm failure inside `ap update website` aborts
+    # the subcommand instead of silently dropping the deploy workflow on top
+    # of a broken website install.
+    subprocess.run(["ap", "update", "website"], check=True)
     create_workflow("deploy")

{afterpython-0.3.10 → afterpython-0.3.12}/src/afterpython/tools/_afterpython.py

@@ -125,6 +125,7 @@ def init_afterpython():
             "thumbnail": "thumbnail.png",
             "announcement": "",
             "readme_py": "wasm",
+            "execute_readme_py": False,
             "api_reference": False,
         },
     }

{afterpython-0.3.10 → afterpython-0.3.12}/src/afterpython/tools/myst.py

@@ -179,6 +179,56 @@ Start building your amazing project! 🚀
     return welcome_file
 
 
+def ensure_pnpm_11(node_env: NodeEnv) -> None:
+    """Ensure pnpm 11.x is available on `node_env`'s PATH. No-op if already satisfied.
+
+    Pinned to major 11 because an unpinned `npm install -g pnpm` previously did
+    a silent 9→10 jump that broke `ap init` via ERR_PNPM_IGNORED_BUILDS. We
+    pre-check the installed version so we don't redundantly invoke `npm install
+    -g`, which fails with EEXIST when pnpm was installed by a different package
+    manager (e.g. Homebrew) that owns the shim filenames npm wants to write.
+    """
+    current: str | None = None
+    try:
+        result = subprocess.run(
+            ["pnpm", "--version"],
+            env=node_env,
+            capture_output=True,
+            text=True,
+            check=False,
+        )
+        if result.returncode == 0:
+            current = result.stdout.strip()
+            if current.startswith("11."):
+                return
+    except FileNotFoundError:
+        pass
+
+    install = subprocess.run(
+        ["npm", "install", "-g", "pnpm@11"],
+        env=node_env,
+        capture_output=True,
+        text=True,
+        check=False,
+    )
+    if install.returncode == 0:
+        return
+
+    msg = ["Failed to install pnpm@11 via npm."]
+    if current:
+        msg.append(f"Detected existing pnpm version: {current}")
+    msg.append(
+        "If pnpm is already installed via another package manager "
+        "(e.g. Homebrew: `brew install pnpm`), npm refuses to overwrite "
+        "its shims. Please either:\n"
+        "  - upgrade your existing pnpm to major version 11, or\n"
+        "  - uninstall it and let afterpython manage pnpm via npm."
+    )
+    if install.stderr:
+        msg.append(f"\nnpm stderr:\n{install.stderr}")
+    raise RuntimeError("\n".join(msg))
+
+
 def init_myst():
     """
     Initialize MyST Markdown (mystmd) and myst.yml files in
@@ -189,14 +239,19 @@ def init_myst():
 
     # find any existing node.js version and use it, if no, install the Node.js version specified in NODEENV_VERSION
     node_env: NodeEnv = find_node_env()
-    # Pin to pnpm major version — `npm install -g pnpm` (unpinned) caused a
-    # silent 9→10 jump that broke `ap init` via ERR_PNPM_IGNORED_BUILDS.
-    subprocess.run(["npm", "install", "-g", "pnpm@11"], env=node_env, check=True)
+    ensure_pnpm_11(node_env)
     for content_type in CONTENT_TYPES:
         path = ap.paths.afterpython_path / content_type
         print(f"Initializing MyST Markdown (mystmd) in {path.name}/ directory ...")
         path.mkdir(parents=True, exist_ok=True)
-        subprocess.run(["myst", "init"], cwd=path, input="n\n", text=True, env=node_env)
+        subprocess.run(
+            ["myst", "init"],
+            cwd=path,
+            input="n\n",
+            text=True,
+            env=node_env,
+            check=True,
+        )
         myst_yml_defaults = {
             "extends": "../authors.yml",
             "project": {