mystmd 1.3.5__tar.gz → 1.3.7__tar.gz

{mystmd-1.3.5 → mystmd-1.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mystmd
-Version: 1.3.5
+Version: 1.3.7
 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
@@ -21,6 +21,8 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.8
+Requires-Dist: platformdirs~=4.2.2
+Requires-Dist: nodeenv~=1.9.1
 Provides-Extra: execute
 Requires-Dist: ipykernel; extra == 'execute'
 Requires-Dist: jupyter-server; extra == 'execute'

{mystmd-1.3.5 → mystmd-1.3.7}/_package.json

@@ -1,6 +1,6 @@
 {
   "name": "mystmd",
-  "version": "1.3.5",
+  "version": "1.3.7",
   "description": "Command line tools for MyST Markdown",
   "author": "Rowan Cockett <rowan@curvenote.com>",
   "license": "MIT",
@@ -45,6 +45,6 @@
     "commander": "^10.0.1",
     "core-js": "^3.31.1",
     "js-yaml": "^4.1.0",
-    "myst-cli": "^1.3.5"
+    "myst-cli": "^1.3.7"
   }
 }

{mystmd-1.3.5 → mystmd-1.3.7}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["hatchling", "hatch-nodejs-version"]
+requires = ["hatchling", "hatch-nodejs-version", "hatch-deps-selector"]
 build-backend = "hatchling.build"
 
 [project]
@@ -34,6 +34,25 @@ myst = "mystmd_py.main:main"
 source = "nodejs"
 path = "_package.json"		
 
+[tool.hatch.build.hooks.selector]
+default-variant = "pypi"
+# Name of the env-var that controls which `selector.variants` entry 
+# is used
+env-var = "MYSTMD_PACKAGE_VARIANT"
+
+# Ensure that we only bring in nodeenv for PyPI
+[tool.hatch.build.hooks.selector.variants.pypi]
+dependencies = [
+  "platformdirs~=4.2.2",
+  "nodeenv~=1.9.1"
+]
+
+# Conda-forge has no additional dependencies to the `project.dependencies`
+# This section is not needed (the env-var can be set to "")
+# But this makes it more explicit
+[tool.hatch.build.hooks.selector.variants.conda-forge]
+dependencies = []
+
 [tool.hatch.metadata.hooks.nodejs]
 fields = ["description", "authors", "urls", "keywords", "license"]
 path = "_package.json"

mystmd-1.3.7/src/mystmd_py/main.py

@@ -0,0 +1,151 @@
+import os
+import pathlib
+import platform
+import shutil
+import subprocess
+import sys
+import re
+import textwrap
+
+
+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
+
+
+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")
+
+    # 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
+
+
+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)
+    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"
+            "ℹ️  We recommend installing the latest LTS release, using your preferred package manager "
+            "or following instructions here: https://nodejs.org\n\n"
+        ) from err
+    except PermissionDeniedError as err:
+        raise SystemExit(
+            "💥 The attempt to install Node.js failed because the user denied the request.\n"
+            "ℹ️  We recommend installing the latest LTS release, using your preferred package manager "
+            "or following instructions here: https://nodejs.org\n\n"
+        ) from err
+
+    # 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"
+        )
+
+    # Find path to compiled JS
+    js_path = (pathlib.Path(__file__).parent / "myst.cjs").resolve()
+
+    # Build args for Node.js process
+    myst_node_args = [js_path, *sys.argv[1:]]
+    myst_env = {**node_env, "MYST_LANG": "PYTHON"}
+
+    # Invoke appropriate binary for platform
+    if platform.system() == "Windows":
+        result = subprocess.run([node_path, *myst_node_args], env=myst_env)
+        sys.exit(result.returncode)
+    else:
+        os.execve(
+            node_path,
+            [node_path.name, *myst_node_args],
+            myst_env,
+        )
+
+
+if __name__ == "__main__":
+    main()

{mystmd-1.3.5 → mystmd-1.3.7}/src/mystmd_py/myst.cjs

@@ -193562,7 +193562,7 @@ var {
 } = import_index.default;
 
 // src/version.ts
-var version = "1.3.5";
+var version = "1.3.7";
 var version_default = version;
 
 // ../myst-cli/dist/build/build.js
@@ -195821,21 +195821,35 @@ function validateJupytext(input3, opts) {
 }
 
 // ../myst-frontmatter/dist/kernelspec/validators.js
-var KERNELSPEC_KEYS = ["name", "language", "display_name", "argv", "env"];
+var KERNELSPEC_KEYS = ["name", "display_name", "language", "argv", "env"];
 function validateKernelSpec(input3, opts) {
   const value = validateObjectKeys(input3, { optional: KERNELSPEC_KEYS }, opts);
   if (value === void 0)
     return void 0;
-  const output2 = {};
+  let name3;
   if (defined(value.name)) {
-    output2.name = validateString(value.name, incrementOptions("name", opts));
+    const validatedName = validateString(value.name, incrementOptions("name", opts));
+    if (validatedName === void 0)
+      return void 0;
+    name3 = validatedName;
+  } else {
+    name3 = "python3";
+    validationWarning(`"name" key is required; using '${name3}' as placeholder value`, opts);
+  }
+  let displayName;
+  if (defined(value.display_name)) {
+    const validatedDisplayName = validateString(value.display_name, incrementOptions("display_name", opts));
+    if (validatedDisplayName === void 0)
+      return void 0;
+    displayName = validatedDisplayName;
+  } else {
+    displayName = `${name3} Kernel`;
+    validationWarning(`"display_name" key is required; using '${displayName}' as placeholder value`, opts);
   }
+  const output2 = { name: name3, display_name: displayName };
   if (defined(value.language)) {
     output2.language = validateString(value.language, incrementOptions("language", opts));
   }
-  if (defined(value.display_name)) {
-    output2.display_name = validateString(value.display_name, incrementOptions("display_name", opts));
-  }
   if (defined(value.env)) {
     output2.env = validateObject(value.env, incrementOptions("env", opts));
   }
@@ -241223,9 +241237,12 @@ function addWarningForFile(session, file, message, severity = "warn", opts) {
       session.log.error(`\u26D4\uFE0F ${prefix2}${formatted}`);
       break;
     case "warn":
-    default:
       session.log.warn(`\u26A0\uFE0F  ${prefix2}${formatted}`);
       break;
+    case "debug":
+    default:
+      session.log.debug(`${prefix2}${formatted}`);
+      break;
   }
   if (opts === null || opts === void 0 ? void 0 : opts.ruleId) {
     session.log.debug(`To suppress this message, add rule: "${opts.ruleId}"${opts.key ? ` with key: "${opts.key}"` : ""} to "error_rules" in your project config`);
@@ -285686,7 +285703,7 @@ var citeRole = {
   run(data) {
     const content3 = data.body;
     const labels = content3.split(/[,;]/).map((s5) => s5.trim());
-    const kind = data.name.startsWith("cite:p") || data.name.includes("par") ? "parenthetical" : "narrative";
+    const kind = data.name.startsWith("cite:p") || data.name.includes("par") || data.name.includes("cite:alp") ? "parenthetical" : "narrative";
     const children = labels.map((c) => {
       var _a6, _b;
       const groups = /^(?:\{([^{]*)\})?([^{]*)(?:\{([^{]*)\})?$/;
@@ -285713,6 +285730,9 @@ var citeRole = {
     if (data.name === "cite" && children.length === 1) {
       return children;
     }
+    if (data.name.includes("cite:alp")) {
+      return children;
+    }
     return [
       {
         type: "citeGroup",
@@ -289018,7 +289038,7 @@ var import_node_path15 = __toESM(require("path"), 1);
 var import_nbtx = __toESM(require_cjs2(), 1);
 
 // ../myst-cli/dist/version.js
-var version2 = "1.3.5";
+var version2 = "1.3.7";
 var version_default2 = version2;
 
 // ../myst-cli/dist/utils/headers.js
@@ -289439,7 +289459,7 @@ async function convertImageToWebp(session, image6, { quality = 80, overwrite = f
       minimumFractionDigits: 2,
       maximumFractionDigits: 2
     });
-    addWarningForFile(session, image6, `Image is too large (${inMB} MB) to convert to webp (build will be slow).`, "warn", { ruleId: RuleId.imageFormatOptimizes });
+    addWarningForFile(session, image6, `Image is too large (${inMB} MB) to convert to webp (build will be slow).`, isGif2webpAvailable() && imageExt === ".gif" || isWebpAvailable() ? "warn" : "debug", { ruleId: RuleId.imageFormatOptimizes });
     return null;
   }
   const dirname8 = import_node_path13.default.dirname(image6);
@@ -289479,7 +289499,7 @@ imagemagick and cwebp are required
       if (!isGif2webpAvailable()) {
         addWarningForFile(session, image6, `Could not convert from image ${image6} to webp:
 gif2webp is required
-`, "warn", { ruleId: RuleId.imageFormatOptimizes });
+`, "debug", { ruleId: RuleId.imageFormatOptimizes });
         return null;
       }
       await convertGif();
@@ -289487,7 +289507,7 @@ gif2webp is required
       if (!isWebpAvailable()) {
         addWarningForFile(session, image6, `Could not convert from image ${image6} to webp:
 cwebp is required
-`, "warn", { ruleId: RuleId.imageFormatOptimizes });
+`, "debug", { ruleId: RuleId.imageFormatOptimizes });
         return null;
       }
       await convertImg();
@@ -302218,7 +302238,7 @@ async function evaluateExpression(kernel, expr) {
   (0, import_node_assert.default)(result !== void 0);
   return { status: result.status, result };
 }
-function buildCacheKey(nodes) {
+function buildCacheKey(kernelSpec, nodes) {
   var _a6, _b, _c;
   const hashableItems = [];
   for (const node3 of nodes) {
@@ -302237,8 +302257,7 @@ function buildCacheKey(nodes) {
       });
     }
   }
-  const hashableString = JSON.stringify(hashableItems);
-  return (0, import_node_crypto4.createHash)("md5").update(hashableString).digest("hex");
+  return (0, import_node_crypto4.createHash)("md5").update(kernelSpec.name).update(JSON.stringify(hashableItems)).digest("hex");
 }
 function isCellBlock(node3) {
   return node3.type === "block" && select("code", node3) !== null && select("output", node3) !== null;
@@ -302298,13 +302317,16 @@ function applyComputedOutputsToNodes(nodes, computedResult) {
   }
 }
 async function kernelExecutionTransform(tree, vfile2, opts) {
-  var _a6, _b, _c, _d2;
+  var _a6;
   const log = (_a6 = opts.log) !== null && _a6 !== void 0 ? _a6 : console;
+  if (opts.frontmatter.kernelspec === void 0) {
+    return fileError(vfile2, `Notebook does not declare the necessary 'kernelspec' frontmatter key required for execution`);
+  }
   const executableNodes = selectAll(`block[kind=${NotebookCell.code}],inlineExpression`, tree);
   if (executableNodes.length === 0) {
     return;
   }
-  const cacheKey = buildCacheKey(executableNodes);
+  const cacheKey = buildCacheKey(opts.frontmatter.kernelspec, executableNodes);
   let cachedResults = opts.cache.get(cacheKey);
   if (opts.ignoreCache || cachedResults === void 0) {
     log.info(`\u{1F4BF} Executing Notebook (${vfile2.path}) ${opts.ignoreCache ? "[cache ignored]" : "[no execution cache found]"}`);
@@ -302320,7 +302342,7 @@ async function kernelExecutionTransform(tree, vfile2, opts) {
         type: "notebook",
         name: import_node_path34.default.basename(vfile2.path),
         kernel: {
-          name: (_d2 = (_c = (_b = opts.frontmatter) === null || _b === void 0 ? void 0 : _b.kernelspec) === null || _c === void 0 ? void 0 : _c.name) !== null && _d2 !== void 0 ? _d2 : "python3"
+          name: opts.frontmatter.kernelspec.name
         }
       };
       await sessionManager.startNew(sessionOpts).catch((err) => {
@@ -323419,14 +323441,21 @@ ${errors4}`);
 function assertNever() {
   throw new Error("unreachable code");
 }
-function convertNoFormat(dir, data) {
-  const rootEntry = { file: (0, import_node_path59.relative)(dir, resolveExtension((0, import_node_path59.join)(dir, data.root))) };
+function maybeResolveDocument(dir, name3, session) {
+  const resolved = resolveExtension((0, import_node_path59.join)(dir, name3));
+  if (resolved) {
+    return (0, import_node_path59.relative)(dir, resolved);
+  }
+  session.log.error(`Could not find a file named ${name3} (declared in table of contents)`);
+  return name3;
+}
+function convertNoFormat(session, dir, data) {
+  const rootEntry = { file: maybeResolveDocument(dir, data.root, session) };
   const convertEntry = (item) => {
     let entry;
     if ("file" in item) {
-      const resolved = resolveExtension((0, import_node_path59.join)(dir, item.file));
       entry = {
-        file: (0, import_node_path59.relative)(dir, resolved),
+        file: maybeResolveDocument(dir, item.file, session),
         title: item.title
       };
     } else if ("url" in item) {
@@ -323543,7 +323572,7 @@ function convertArticleToNoFormat(data) {
   }
   return result;
 }
-function upgradeTOC(data) {
+function upgradeTOC(session, data) {
   const dir = (0, import_node_process6.cwd)();
   let dataNoFormat;
   if ("format" in data) {
@@ -323562,7 +323591,7 @@ function upgradeTOC(data) {
   } else {
     dataNoFormat = data;
   }
-  return convertNoFormat(dir, dataNoFormat);
+  return convertNoFormat(session, dir, dataNoFormat);
 }
 
 // ../myst-cli/dist/init/jupyter-book/syntax.js
@@ -323758,13 +323787,15 @@ async function upgradeJupyterBook(session, configFile) {
   const configContent = await import_promises4.default.readFile("_config.yml", { encoding: "utf-8" });
   const configData2 = validateJupyterBookConfig(js_yaml_default.load(configContent));
   if (defined2(configData2)) {
+    session.log.info(`Migrating Jupyter Book configuration to ${source_default.blue("myst.yml")}`);
     ({ site: config3.site, project: config3.project } = upgradeConfig(configData2));
   }
   if (await fsExists("_toc.yml")) {
     const tocContent = await import_promises4.default.readFile("_toc.yml", { encoding: "utf-8" });
     const tocData = validateSphinxExternalTOC(js_yaml_default.load(tocContent));
     if (defined2(tocData)) {
-      config3.project.toc = upgradeTOC(tocData);
+      session.log.info(`Migrating TOC to ${source_default.blue("myst.yml")}`);
+      config3.project.toc = upgradeTOC(session, tocData);
     }
   }
   await upgradeProjectSyntax(session);

mystmd-1.3.7/src/mystmd_py/nodeenv.py

@@ -0,0 +1,76 @@
+import os
+import pathlib
+import shutil
+import subprocess
+import sys
+
+
+NODEENV_VERSION = "18.0.0"
+INSTALL_NODEENV_KEY = "MYSTMD_ALLOW_NODEENV"
+
+
+class PermissionDeniedError(Exception): ...
+
+
+class NodeEnvCreationError(Exception): ...
+
+
+def find_installed_node():
+    return shutil.which("node") or shutil.which("node.exe") or shutil.which("node.cmd")
+
+
+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
+
+
+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")
+
+    new_path = os.pathsep.join(
+        [*binary_path.split(os.pathsep), str(nodeenv_path / "bin")]
+    )
+    return nodeenv_path / "bin" / "node", new_path
+
+

mystmd-1.3.5/src/mystmd_py/main.py

@@ -1,46 +0,0 @@
-import os
-import pathlib
-import shutil
-import subprocess
-import sys
-import re
-
-
-def main():
-    NODE_LOCATION = (
-        shutil.which("node") or shutil.which("node.exe") or shutil.which("node.cmd")
-    )
-    PATH_TO_BIN_JS = (pathlib.Path(__file__).parent / "myst.cjs").resolve()
-
-    if not NODE_LOCATION:
-        raise SystemExit(
-            "You must install node >=18 to run MyST\n\n"
-            "We recommend installing the latest LTS release, using your preferred package manager\n"
-            "or following instructions here: https://nodejs.org/en/download"
-        )
-    node = pathlib.Path(NODE_LOCATION).absolute()
-
-    _version = subprocess.run(
-        [node, "-v"], capture_output=True, check=True, text=True
-    ).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"
-        )
-    os.execve(
-        node,
-        [node.name, PATH_TO_BIN_JS, *sys.argv[1:]],
-        {**os.environ, "MYST_LANG": "PYTHON"},
-    )
-
-
-if __name__ == "__main__":
-    main()