Add interactive Pyodide playground for SQLSpec documentation

Signed-off-by: euri10 <[email protected]>

Author: euri10

docs/_ext/__init__.py

@@ -0,0 +1,43 @@
+# docs/_ext/playground.py
+
+import logging
+from pathlib import Path
+from uuid import uuid4
+
+from docutils import nodes
+from docutils.parsers.rst import Directive
+from jinja2 import Environment, FileSystemLoader
+
+logger = logging.getLogger(__name__)
+
+
+class WasmPlayground(Directive):
+    """
+    A custom Sphinx directive to embed a Pyodide-powered code playground.
+    """
+
+    logger.info("Initializing WasmPlayground directive")
+    has_content = True
+
+    def run(self):
+        # Generate unique IDs for the HTML elements
+        id = uuid4().hex
+        print(id)
+        env = Environment(loader=FileSystemLoader(Path(__file__).parent))
+        template = env.get_template("playground_template.html")
+        rendered = template.render(id=id)
+        return [nodes.raw(text=rendered, format="html")]
+
+
+def setup(app):
+    """
+    Register the directive with Sphinx.
+    """
+    app.add_js_file("https://cdn.jsdelivr.net/pyodide/v0.29.0/full/pyodide.js", priority=100)
+    app.add_directive("wasm-playground", WasmPlayground)
+    return {
+        "version": "1.0",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }
+

docs/_ext/playground.py

@@ -0,0 +1,72 @@
+<h2>🐍 Pyodide + SQLSpec Runner</h2>
+  <textarea id="editor-{{ uuid }}">
+# Try Python code here
+import sqlspec
+print("sqlspec version:", sqlspec.__version__)
+  </textarea>
+  <br>
+  <button id="run-button-{{ uuid }}">Loading...</button>
+
+  <pre id="output-{{ uuid }}"></pre>
+
+  <!-- ✅ Load Pyodide runtime -->
+  <script src="https://cdn.jsdelivr.net/pyodide/v0.29.0/full/pyodide.js"></script>
+
+  <!-- ✅ Your app logic -->
+  <script>
+    (async function() {
+      const editor = document.getElementById("editor-{{ uuid }}");
+      const output = document.getElementById("output-{{ uuid }}");
+      const runButton = document.getElementById("run-button-{{ uuid }}");
+
+      let pyodide = null;
+
+      function writeToOutput(s) {
+        output.textContent += s + "\n";
+        output.scrollTop = output.scrollHeight;
+      }
+
+      async function initPyodide() {
+        try {
+          pyodide = await loadPyodide();
+          pyodide.setStdout({ batched: writeToOutput });
+          pyodide.setStderr({ batched: writeToOutput });
+          output.textContent = "✅ Pyodide loaded.\nInstalling micropip...\n";
+
+          await pyodide.loadPackage("micropip");
+          const micropip = pyodide.pyimport("micropip");
+
+
+          output.textContent += "Installing sqlspec (this may take ~30s)...\n";
+          await micropip.install("sqlspec[aiosqlite]");
+          await micropip.install("sqlite3");
+
+          output.textContent += "✅ Ready! You can now run Python code.\n";
+          runButton.disabled = false;
+          runButton.textContent = "▶ Run";
+        } catch (err) {
+          output.textContent = "❌ Error loading Pyodide: " + err;
+          console.error(err);
+        }
+      }
+
+      runButton.disabled = true;
+      runButton.textContent = "Loading...";
+      runButton.onclick = async () => {
+        if (!pyodide) {
+          output.textContent = "Pyodide is not loaded yet.";
+          return;
+        }
+        const code = editor.value;
+        output.textContent = "Running code...\n";
+        try {
+          await pyodide.runPythonAsync(code);
+        } catch (err) {
+          writeToOutput("Python Error: " + err);
+          console.error(err);
+        }
+      };
+
+      initPyodide();
+    })();
+  </script>

docs/_ext/playground_template.html

@@ -61,6 +61,7 @@
     "sphinx_togglebutton",
     "sphinx_paramlinks",
     "sphinxcontrib.mermaid",
+    "docs._ext.playground"
 ]
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),

docs/conf.py

@@ -51,6 +51,7 @@ SQLSpec is **NOT an ORM**. It is a flexible connectivity layer that provides a c
     usage/index
     examples/index
     reference/index
+    playground
 
 .. toctree::
     :hidden:

docs/index.rst

@@ -0,0 +1,9 @@
+======================
+Live Playground
+======================
+
+You can try ``sqlspec`` live in your browser. The code block below
+is a full, interactive Python environment powered by Pyodide
+(WebAssembly).
+
+.. wasm-playground::