markdown-exec 1.10.3__tar.gz → 1.11.0__tar.gz

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/CHANGELOG.md

@@ -5,6 +5,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.11.0](https://github.com/pawamoy/markdown-exec/releases/tag/1.11.0) - 2025-06-28
+
+<small>[Compare with 1.10.4](https://github.com/pawamoy/markdown-exec/compare/1.10.4...1.11.0)</small>
+
+### Features
+
+- Add option to set height of Pyodide/Ace editors ([c64a2ef](https://github.com/pawamoy/markdown-exec/commit/c64a2efd8cb7a7a691039e866dab5839f8ef8bfe) by Jayant Pranjal). [Issue-41](https://github.com/pawamoy/markdown-exec/issues/41), Co-authored-by: Jayant <jayant@Jayants-MacBook-Air.local>, Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
+
+## [1.10.4](https://github.com/pawamoy/markdown-exec/releases/tag/1.10.4) - 2025-06-27
+
+<small>[Compare with 1.10.3](https://github.com/pawamoy/markdown-exec/compare/1.10.3...1.10.4)</small>
+
+### Bug Fixes
+
+- Don't fail when used as Markdown extension and MkDocs is not installed ([7722250](https://github.com/pawamoy/markdown-exec/commit/7722250931f44d2328af69cd20143035d3ba404e) by Timothée Mazzucotelli). [Issue-91](https://github.com/pawamoy/markdown-exec/discussions/91)
+
 ## [1.10.3](https://github.com/pawamoy/markdown-exec/releases/tag/1.10.3) - 2025-03-24
 
 <small>[Compare with 1.10.2](https://github.com/pawamoy/markdown-exec/compare/1.10.2...1.10.3)</small>

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown-exec
-Version: 1.10.3
+Version: 1.11.0
 Summary: Utilities to execute code blocks in Markdown files.
 Keywords: markdown,python,exec,shell,bash,mkdocs
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/docs/usage/pyodide.md

@@ -45,6 +45,56 @@ print("Hello.")
 
 NOTE: **All Pyodide blocks on the same page should use the same version!**
 
+## Editor height
+
+The height of the editor can be configured with the `height` option. It accepts the following values:
+
+- `0` or `auto`: A fixed number of lines, based on initial code.
+- a positive number, like `10`: A fixed number of lines.
+- a positive range, like `5-30`: The minimum and maximum number of lines. The editor will shring/grow as you type.
+
+The default is `auto`.
+
+A few examples:
+
+````md exec="1" source="tabbed-left" tabs="Markdown|Rendered" title="Fixed height (10 lines)"
+```pyodide height="10"
+from typing import Iterator
+
+# This is an example
+class Math:
+    @staticmethod
+    def fib(n: int) -> Iterator[int]:
+        """Fibonacci series up to n."""
+        a, b = 0, 1
+        while a < n:
+            yield a
+            a, b = b, a + b
+
+result = sum(Math.fib(42))
+print(f"The answer is {result}")
+```
+````
+
+````md exec="1" source="tabbed-left" tabs="Markdown|Rendered" title="Between 1 and 40 lines"
+```pyodide height="1-40"
+from typing import Iterator
+
+# This is an example
+class Math:
+    @staticmethod
+    def fib(n: int) -> Iterator[int]:
+        """Fibonacci series up to n."""
+        a, b = 0, 1
+        while a < n:
+            yield a
+            a, b = b, a + b
+
+result = sum(Math.fib(42))
+print(f"The answer is {result}")
+```
+````
+
 ## Sessions
 
 Editors with the same session share the same `globals()` dictionary,

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/duties.py

@@ -237,7 +237,7 @@ def coverage(ctx: Context) -> None:
 
 
 @duty
-def test(ctx: Context, *cli_args: str, match: str = "") -> None:
+def test(ctx: Context, *cli_args: str, match: str = "") -> None:  # noqa: PT028
     """Run the test suite.
 
     Parameters:

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/mkdocs.yml

@@ -154,11 +154,12 @@ plugins:
           signature_crossrefs: true
           summary: true
 - llmstxt:
-    files:
-    - output: llms-full.txt
-      inputs:
+    full_output: llms-full.txt
+    sections:
+      Usage:
       - index.md
-      - reference/**.md
+      API:
+      - reference/api.md
 - git-revision-date-localized:
     enabled: !ENV [DEPLOY, false]
     enable_creation_date: true

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/pyproject.toml

@@ -45,7 +45,7 @@ classifiers = [
 dependencies = [
     "pymdown-extensions>=9",
 ]
-version = "1.10.3"
+version = "1.11.0"
 
 [project.optional-dependencies]
 ansi = [
@@ -72,6 +72,7 @@ getter = "scripts.get_version:get_version"
 [tool.pdm.build]
 excludes = [
     "**/.pytest_cache",
+    "**/.mypy_cache",
 ]
 source-includes = [
     "config",
@@ -120,7 +121,7 @@ docs = [
     "mkdocs>=1.6",
     "mkdocs-coverage>=1.0",
     "mkdocs-git-revision-date-localized-plugin>=1.2",
-    "mkdocs-llmstxt>=0.1",
+    "mkdocs-llmstxt>=0.2",
     "mkdocs-material>=9.5",
     "mkdocs-minify-plugin>=0.8",
     "mkdocs-section-index>=0.3",

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/src/markdown_exec/__init__.py

@@ -12,7 +12,6 @@ from markdown_exec._internal.formatters.base import (
 )
 from markdown_exec._internal.logger import get_logger, patch_loggers
 from markdown_exec._internal.main import MARKDOWN_EXEC_AUTO, formatter, formatters, validator
-from markdown_exec._internal.mkdocs_plugin import MarkdownExecPlugin, MarkdownExecPluginConfig
 from markdown_exec._internal.processors import (
     HeadingReportingTreeprocessor,
     IdPrependingTreeprocessor,
@@ -36,8 +35,6 @@ __all__ = [
     "InsertHeadings",
     "MarkdownConfig",
     "MarkdownConverter",
-    "MarkdownExecPlugin",
-    "MarkdownExecPluginConfig",
     "RemoveHeadings",
     "add_source",
     "base_format",
@@ -53,3 +50,14 @@ __all__ = [
     "validator",
     "working_directory",
 ]
+
+
+try:
+    from markdown_exec._internal.mkdocs_plugin import MarkdownExecPlugin, MarkdownExecPluginConfig
+except ImportError:
+    pass
+else:
+    __all__ += [
+        "MarkdownExecPlugin",
+        "MarkdownExecPluginConfig",
+    ]

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/src/markdown_exec/_internal/formatters/pyodide.py

@@ -37,7 +37,15 @@ _template = """
 
 <script>
 document.addEventListener('DOMContentLoaded', (event) => {
-    setupPyodide('%(id_prefix)s', install=%(install)s, themeLight='%(theme_light)s', themeDark='%(theme_dark)s', session='%(session)s');
+    setupPyodide(
+        '%(id_prefix)s',
+        install=%(install)s,
+        themeLight='%(theme_light)s',
+        themeDark='%(theme_dark)s',
+        session='%(session)s',
+        minLines=%(min_lines)s,
+        maxLines=%(max_lines)s,
+    );
 });
 </script>
 """
@@ -45,9 +53,26 @@ document.addEventListener('DOMContentLoaded', (event) => {
 _counter = 0
 
 
+def _calculate_height(code: str, extra: dict) -> tuple[int, int]:
+    """Calculate height configuration for the Pyodide editor."""
+    height = extra.pop("height", "auto")
+
+    if height in ("auto", "0"):
+        min_lines = max_lines = len(code.strip().splitlines()) if code.strip() else 5
+    elif "-" in height:
+        min_lines, max_lines = height.split("-")
+        min_lines = max(1, int(min_lines or "5"))
+        max_lines = max(min_lines, int(max_lines or "30"))
+    else:
+        min_lines = max_lines = int(height)
+
+    return min_lines, max_lines
+
+
 def _format_pyodide(code: str, md: Markdown, session: str, extra: dict, **options: Any) -> str:  # noqa: ARG001
     global _counter  # noqa: PLW0603
     _counter += 1
+
     version = extra.pop("version", "0.26.4").lstrip("v")
     install = extra.pop("install", "")
     install = install.split(",") if install else []
@@ -56,6 +81,7 @@ def _format_pyodide(code: str, md: Markdown, session: str, extra: dict, **option
     if "," not in theme:
         theme = f"{theme},{theme}"
     theme_light, theme_dark = theme.split(",")
+    min_lines, max_lines = _calculate_height(code, extra)
 
     data = {
         "id_prefix": f"exec-{_counter}--",
@@ -66,6 +92,8 @@ def _format_pyodide(code: str, md: Markdown, session: str, extra: dict, **option
         "session": session or "default",
         "play_emoji": _play_emoji,
         "clear_emoji": _clear_emoji,
+        "min_lines": min_lines,
+        "max_lines": max_lines,
     }
     rendered = _template % data
     if exclude_assets:

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/src/markdown_exec/assets/pyodide.css

@@ -13,8 +13,6 @@ html[data-theme="dark"] {
 
 .pyodide-editor {
     width: 100%;
-    min-height: 200px;
-    max-height: 400px;
     font-size: .85em;
 }
 

{markdown_exec-1.10.3 → markdown_exec-1.11.0}/src/markdown_exec/assets/pyodide.js

@@ -77,7 +77,15 @@ function updateTheme(editor, light, dark) {
     });
 }
 
-async function setupPyodide(idPrefix, install = null, themeLight = 'tomorrow', themeDark = 'tomorrow_night', session = null) {
+async function setupPyodide(
+    idPrefix,
+    install = null,
+    themeLight = 'tomorrow',
+    themeDark = 'tomorrow_night',
+    session = null,
+    minLines = 5,
+    maxLines = 30,
+) {
     const editor = ace.edit(idPrefix + "editor");
     const run = document.getElementById(idPrefix + "run");
     const clear = document.getElementById(idPrefix + "clear");
@@ -88,6 +96,12 @@ async function setupPyodide(idPrefix, install = null, themeLight = 'tomorrow', t
     editor.session.setMode("ace/mode/python");
     setTheme(editor, getTheme(), themeLight, themeDark);
 
+    editor.setOption("minLines", minLines);
+    editor.setOption("maxLines", maxLines);
+
+    // Force editor to resize after setting options
+    editor.resize();
+
     writeOutput(output, "Initializing...");
     let pyodide = await pyodidePromise;
     if (install && install.length) {