mystmd 1.3.6__py3-none-any.whl → 1.3.8__py3-none-any.whl

{mystmd-1.3.6.dist-info → mystmd-1.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mystmd
-Version: 1.3.6
+Version: 1.3.8
 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.8.dist-info/RECORD

@@ -0,0 +1,9 @@
+mystmd_py/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mystmd_py/main.py,sha256=o4Kz4iw3TEAw63qPsTuX0lrrq-tFEbrUbrxC4dTlXB8,4855
+mystmd_py/myst.cjs,sha256=CMFNN3Q13AfakBIB9G_kZw0Hk_o_d-j1sMP39yJnvBo,13104265
+mystmd_py/nodeenv.py,sha256=3dJ9ZmO5u4smh5EkmOPDYOuHR8-5or181ifPHY-TBaA,2089
+mystmd-1.3.8.dist-info/METADATA,sha256=f7jBsGyPHN4E4eJsY3jWiHIRSWGPQVSQQ_20ecboL_E,3019
+mystmd-1.3.8.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+mystmd-1.3.8.dist-info/entry_points.txt,sha256=eC2ol2gqS2q5E-ktkMrBSvV0tckGUcNGS-c4hEQ-_V4,45
+mystmd-1.3.8.dist-info/licenses/LICENSE,sha256=4BcikqvulW5nh_MxaocO-lC7ydIX23dMbcqtNTUSxr4,1082
+mystmd-1.3.8.dist-info/RECORD,,

mystmd_py/main.py

@@ -1,33 +1,125 @@
 import os
 import pathlib
+import platform
 import shutil
 import subprocess
 import sys
 import re
+import textwrap
 
 
-def main():
-    NODE_LOCATION = (
-        shutil.which("node") or shutil.which("node.exe") or shutil.which("node.cmd")
+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
     )
-    PATH_TO_BIN_JS = (pathlib.Path(__file__).parent / "myst.cjs").resolve()
 
-    if not NODE_LOCATION:
+
+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(
-            "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()
+            "💥 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, "-v"], capture_output=True, check=True, text=True
+        [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(
@@ -35,11 +127,24 @@ def main():
             "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"},
-    )
+
+    # 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__":

mystmd_py/myst.cjs

@@ -193562,7 +193562,7 @@ var {
 } = import_index.default;
 
 // src/version.ts
-var version = "1.3.6";
+var version = "1.3.8";
 var version_default = version;
 
 // ../myst-cli/dist/build/build.js
@@ -280389,7 +280389,7 @@ function runDirectives(state) {
         directiveOpen.map = map14;
         directiveOpen.meta = {
           arg: arg2,
-          options: simplifyDirectiveOptions(options),
+          options: getDirectiveOptions(options),
           // Tightness is computed for all directives (are they separated by a newline before/after)
           tight: computeBlockTightness(state.src, token.map)
         };
@@ -280471,7 +280471,7 @@ function parseDirectiveContent(content3, info, state) {
         const match3 = COLON_OPTION_REGEX.exec(line2);
         const { option: option3, value } = (_a6 = match3 === null || match3 === void 0 ? void 0 : match3.groups) !== null && _a6 !== void 0 ? _a6 : {};
         if (option3)
-          options.push([option3, value || "true"]);
+          options.push([option3, value || true]);
         bodyOffset++;
       }
     }
@@ -280482,31 +280482,28 @@ function parseDirectiveContent(content3, info, state) {
 function directiveArgToTokens(arg2, lineNumber, state) {
   return nestedPartToTokens("directive_arg", arg2, lineNumber, state, "run_directives", true);
 }
-function simplifyDirectiveOptions(options) {
+function getDirectiveOptions(options) {
   if (!options)
     return void 0;
   const simplified = {};
   options.forEach(([key2, val]) => {
     if (simplified[key2] !== void 0) {
       return;
-    } else if (!isNaN(Number(val))) {
-      simplified[key2] = Number(val);
-    } else if (typeof val === "string" && val.toLowerCase() === "true") {
-      simplified[key2] = true;
-    } else if (typeof val === "string" && val.toLowerCase() === "false") {
-      simplified[key2] = false;
-    } else {
-      simplified[key2] = val;
     }
+    simplified[key2] = val;
   });
   return simplified;
 }
 function directiveOptionsToTokens(options, lineNumber, state) {
   const tokens = options.map(([key2, value], index4) => {
-    const optTokens = nestedPartToTokens("directive_option", `${value}`, lineNumber + index4, state, "run_directives", true);
+    const optTokens = typeof value === "string" ? nestedPartToTokens("directive_option", value, lineNumber + index4, state, "run_directives", true) : [
+      new state.Token("directive_option_open", "", 1),
+      new state.Token("directive_option_close", "", -1)
+    ];
     if (optTokens.length) {
       optTokens[0].info = key2;
-      optTokens[0].content = value;
+      optTokens[0].content = typeof value === "string" ? value : "";
+      optTokens[0].meta = { value };
     }
     return optTokens;
   });
@@ -287928,7 +287925,7 @@ var defaultMdast = {
     getAttrs(t2) {
       return {
         name: t2.info,
-        value: t2.content
+        value: t2.meta.value
       };
     }
   },
@@ -288129,6 +288126,8 @@ function contentFromNode(node3, spec, vfile2, description, ruleId) {
     return void 0;
   }
   if (spec.type === ParseTypesEnum.string || spec.type === String) {
+    if (value === true)
+      return "";
     if (typeof value !== "string" && !(value && typeof value === "number" && !isNaN(value))) {
       fileWarn(vfile2, `value is not a string for ${description}`, { node: node3, ruleId });
     }
@@ -288136,7 +288135,7 @@ function contentFromNode(node3, spec, vfile2, description, ruleId) {
   }
   if (spec.type === ParseTypesEnum.number || spec.type === Number) {
     const valueAsNumber = Number(value);
-    if (isNaN(valueAsNumber)) {
+    if (value === true || isNaN(valueAsNumber)) {
       const fileFn = spec.required ? fileError : fileWarn;
       fileFn(vfile2, `number not provided for ${description}`, { node: node3, ruleId });
       return void 0;
@@ -288471,17 +288470,22 @@ var cardDirective = {
   name: "card",
   alias: ["grid-item-card"],
   arg: {
-    type: "myst"
+    type: "myst",
+    doc: "The title of the card, usually shown as bolded text at the top of the card."
   },
   options: {
-    link: {
-      type: String
+    url: {
+      type: String,
+      alias: ["link"],
+      doc: "Turns the card into a link, can be internal or external."
     },
     header: {
-      type: "myst"
+      type: "myst",
+      doc: "Adds a header to the card."
     },
     footer: {
-      type: "myst"
+      type: "myst",
+      doc: "Adds a footer to the card."
     }
     // // https://sphinx-design.readthedocs.io/en/furo-theme/cards.html#card-options
     // width
@@ -288512,10 +288516,11 @@ var cardDirective = {
   },
   body: {
     type: "myst",
-    required: true
+    required: true,
+    doc: "Main body content of the card."
   },
   run(data) {
-    const { link: link4, header, footer: footer2 } = data.options || {};
+    const { url, header, footer: footer2 } = data.options || {};
     let headerChildren;
     let bodyChildren;
     let footerChildren;
@@ -288552,7 +288557,7 @@ var cardDirective = {
     return [
       {
         type: "card",
-        url: link4,
+        url,
         children
       }
     ];
@@ -289038,7 +289043,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.6";
+var version2 = "1.3.8";
 var version_default2 = version2;
 
 // ../myst-cli/dist/utils/headers.js
@@ -302319,13 +302324,13 @@ function applyComputedOutputsToNodes(nodes, computedResult) {
 async function kernelExecutionTransform(tree, vfile2, opts) {
   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;
   }
+  if (opts.frontmatter.kernelspec === void 0) {
+    return fileError(vfile2, `Notebook does not declare the necessary 'kernelspec' frontmatter key required for execution`);
+  }
   const cacheKey = buildCacheKey(opts.frontmatter.kernelspec, executableNodes);
   let cachedResults = opts.cache.get(cacheKey);
   if (opts.ignoreCache || cachedResults === void 0) {
@@ -304400,6 +304405,10 @@ var ENVIRONMENTS2 = [
 ];
 var RE_OPEN2 = new RegExp(`^\\\\begin{(${ENVIRONMENTS2.join("|")})([*]?)}`);
 function isAmsmathEnvironment(value) {
+  const matches4 = value.trim().matchAll(new RegExp(`\\\\begin{(${ENVIRONMENTS2.join("|")})}`, "g"));
+  if ([...matches4].length > 1) {
+    return false;
+  }
   const matchOpen = value.trim().match(RE_OPEN2);
   if (!matchOpen)
     return false;

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.6.dist-info/RECORD

@@ -1,8 +0,0 @@
-mystmd_py/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mystmd_py/main.py,sha256=BaPniv8thshA5DKIBoq2huFUs1Jb0zFkMxN2UIHXUkw,1511
-mystmd_py/myst.cjs,sha256=FxEBSPoYyXHIws693tzyrUqdWGKTKrIeWQN38ZQSPcc,13103855
-mystmd-1.3.6.dist-info/METADATA,sha256=edCiMgoJBMsYUhBcw_gfIGm94Cwfwno7-zpdcXdxLMU,2954
-mystmd-1.3.6.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-mystmd-1.3.6.dist-info/entry_points.txt,sha256=eC2ol2gqS2q5E-ktkMrBSvV0tckGUcNGS-c4hEQ-_V4,45
-mystmd-1.3.6.dist-info/licenses/LICENSE,sha256=4BcikqvulW5nh_MxaocO-lC7ydIX23dMbcqtNTUSxr4,1082
-mystmd-1.3.6.dist-info/RECORD,,