mystmd 1.3.11__py3-none-any.whl → 1.3.13__py3-none-any.whl

{mystmd-1.3.11.dist-info → mystmd-1.3.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mystmd
-Version: 1.3.11
+Version: 1.3.13
 Summary: Command line tools for MyST Markdown
 Project-URL: Homepage, https://github.com/jupyter-book/mystmd
 Project-URL: Bug Tracker, https://github.com/jupyter-book/mystmd/issues

mystmd-1.3.13.dist-info/RECORD

@@ -0,0 +1,9 @@
+mystmd_py/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mystmd_py/main.py,sha256=qFAnpbiqjx7jXMMmPSVUBA7SSxuRjmr6SiRDBH0rhKQ,2767
+mystmd_py/myst.cjs,sha256=z1cqssoroKQJavI9gm75su-B4trJBNvwEttguXX6h_c,13133280
+mystmd_py/nodeenv.py,sha256=8KER0P-WIXM2MsRJF4vcedBKscGoc26lJKojbkDxjbg,2447
+mystmd-1.3.13.dist-info/METADATA,sha256=sxBlJ6WJCBKKei912qNEejN6g5AcV_21KZjBlEQBpT8,3020
+mystmd-1.3.13.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+mystmd-1.3.13.dist-info/entry_points.txt,sha256=eC2ol2gqS2q5E-ktkMrBSvV0tckGUcNGS-c4hEQ-_V4,45
+mystmd-1.3.13.dist-info/licenses/LICENSE,sha256=4BcikqvulW5nh_MxaocO-lC7ydIX23dMbcqtNTUSxr4,1082
+mystmd-1.3.13.dist-info/RECORD,,

mystmd_py/main.py

@@ -1,104 +1,45 @@
 import os
 import pathlib
 import platform
-import shutil
 import subprocess
 import sys
 import re
 import textwrap
 
+from .nodeenv import find_any_node, PermissionDeniedError, NodeEnvCreationError
 
-NODEENV_VERSION = "18.0.0"
-INSTALL_NODEENV_KEY = "MYSTMD_ALLOW_NODEENV"
-
-
-class PermissionDeniedError(Exception): ...
-
-
-class NodeEnvCreationError(Exception): ...
-
-
-def is_windows():
-    return platform.system() == "Windows"
-
-
-def find_installed_node():
-    # shutil.which can find things with PATHEXT, but 3.12.0 breaks this by preferring NODE over NODE.EXE on Windows
-    return shutil.which("node.exe") if is_windows() else shutil.which("node")
-
-
-def find_nodeenv_path():
-    # The conda packaging of this package does not need to install node!
-    import platformdirs
-
-    return platformdirs.user_data_path(
-        appname="myst", appauthor=False, version=NODEENV_VERSION
-    )
-
-
-def ask_to_install_node(path):
-    if env_value := os.environ.get(INSTALL_NODEENV_KEY, "").lower():
-        return env_value in {"yes", "true", "1", "y"}
-
-    return input(f"❔ Install Node.js in '{path}'? (y/N): ").lower() == "y"
-
-
-def create_nodeenv(env_path):
-    command = [
-        sys.executable,
-        "-m",
-        "nodeenv",
-        "-v",
-        f"--node={NODEENV_VERSION}",
-        "--prebuilt",
-        "--clean-src",
-        env_path,
-    ]
-    result = subprocess.run(command, capture_output=True, encoding="utf-8")
-    if result.returncode:
-        shutil.rmtree(env_path)
-        raise NodeEnvCreationError(result.stderr)
-    else:
-        return env_path
 
+NODEENV_VERSION = "18.0.0"
 
-def find_any_node(binary_path):
-    node_path = find_installed_node()
-    if node_path is not None:
-        return pathlib.Path(node_path).absolute(), binary_path
 
-    nodeenv_path = find_nodeenv_path()
-    if not nodeenv_path.exists():
-        print("❗ Node.js (node) is required to run MyST, but could not be found`.")
-        if ask_to_install_node(nodeenv_path):
-            print(f"⚙️ Attempting to install Node.js in {nodeenv_path} ...")
-            create_nodeenv(nodeenv_path)
-            print(f"ℹ️ Successfully installed Node.js {NODEENV_VERSION}")
-        else:
-            raise PermissionDeniedError("Node.js installation was not permitted")
+def ensure_valid_version(node_path, node_env):
+    # Check version
+    _version = subprocess.run(
+        [node_path, "-v"], capture_output=True, check=True, text=True, env=node_env
+    ).stdout
+    major_version_match = re.match(r"v(\d+).*", _version)
 
-    # Find the executable path
-    new_node_path = (
-        (nodeenv_path / "Scripts" / "node.exe")
-        if is_windows()
-        else (nodeenv_path / "bin" / "node")
-    )
-    new_path = os.pathsep.join(
-        [*binary_path.split(os.pathsep), str(new_node_path.parent)]
-    )
-    return new_node_path, new_path
+    if major_version_match is None:
+        raise SystemExit(f"MyST could not determine the version of Node.js: {_version}")
+    major_version = int(major_version_match[1])
+    if not (major_version in {18, 20, 22} or major_version > 22):
+        raise SystemExit(
+            f"MyST requires node 18, 20, or 22+; you are running node {major_version}.\n\n"
+            "Please update to the latest LTS release, using your preferred package manager\n"
+            "or following instructions here: https://nodejs.org/en/download"
+        )
 
 
 def main():
     # Find NodeJS (and potential new PATH)
     binary_path = os.environ.get("PATH", os.defpath)
     try:
-        node_path, os_path = find_any_node(binary_path)
+        node_path, os_path = find_any_node(binary_path, nodeenv_version=NODEENV_VERSION)
     except NodeEnvCreationError as err:
         message = textwrap.indent(err.args[0], "    ")
         raise SystemExit(
             "💥 The attempt to install Node.js was unsuccessful.\n"
-            f"🔍 Underlying error:\n{message}\n\n"
+            f"🔍  Underlying error:\n{message}\n\n"
             "ℹ️  We recommend installing the latest LTS release, using your preferred package manager "
             "or following instructions here: https://nodejs.org\n\n"
         ) from err
@@ -112,21 +53,8 @@ def main():
     # Build new env dict
     node_env = {**os.environ, "PATH": os_path}
 
-    # Check version
-    _version = subprocess.run(
-        [node_path, "-v"], capture_output=True, check=True, text=True, env=node_env
-    ).stdout
-    major_version_match = re.match(r"v(\d+).*", _version)
-
-    if major_version_match is None:
-        raise SystemExit(f"MyST could not determine the version of Node.js: {_version}")
-    major_version = int(major_version_match[1])
-    if not (major_version in {18, 20, 22} or major_version > 22):
-        raise SystemExit(
-            f"MyST requires node 18, 20, or 22+; you are running node {major_version}.\n\n"
-            "Please update to the latest LTS release, using your preferred package manager\n"
-            "or following instructions here: https://nodejs.org/en/download"
-        )
+    # Ensure Node.js is compatible
+    ensure_valid_version(node_path, node_env)
 
     # Find path to compiled JS
     js_path = (pathlib.Path(__file__).parent / "myst.cjs").resolve()