Bring back cleaning of notebooks (#203)

- Add local `pre-commit` hook that will ensure any notebooks added to the gallery won't contain any output cells
- Fix `Checkerboard` notebook

.pre-commit-config.yaml

@@ -18,3 +18,11 @@ repos:
   hooks:
   - id: black
     exclude: 'solutions'
+
+- repo: local
+  hooks:
+  - id: clean-notebooks
+    name: clean-notebooks
+    entry: ./scripts/clean-notebooks.sh
+    language: script
+    files: \.ipynb$

blog/src/gallery/Checkerboard.ipynb

@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -13,7 +13,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -24,13 +24,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
     "@ar.definition\n",
     "def Checkerboard(width, height) -> ar.Image:\n",
-    "    board = Grid(shape=CheckerPattern())\n",
+    "    board = Grid(defn=CheckerPattern())\n",
     "    return ar.fill(board(width, height))\n",
     "\n",
     "checkerboard = Checkerboard()"
@@ -64,9 +64,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.1-final"
+   "version": "3.8.2"
   }
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

blog/src/gallery/Rolling Hills.ipynb

@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -14,7 +14,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -37,7 +37,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -95,9 +95,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.1-final"
+   "version": "3.8.2"
   }
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

blog/src/gallery/Simple Clock.ipynb

@@ -16,7 +16,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -45,7 +45,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -87,7 +87,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -118,7 +118,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -162,7 +162,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -210,7 +210,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -262,9 +262,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.1-final"
+   "version": "3.8.2"
   }
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

scripts/clean-notebooks.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+# This ensures that all of te tutorial notebook files have no
+# content when committed. It does the following:
+#
+# 1. Take the MD5 hash of the original file.
+# 2. Strip out all the output cells from the file, saving to a temp file
+# 3. Take the MD5 hash of the converted file.
+# 4. If they are different, copy the file over the original and add it to the
+#    list of modified
+
+for f in "$@"
+do
+    md5Orig=$(md5sum "$f" | cut -f 1 -d \  )
+
+    outDir=$(dirname "$f")
+    out="${outDir}/tmp.ipynb"
+
+    jupyter nbconvert --log-level=ERROR \
+            --ClearOutputPreprocessor.enabled=True \
+            --to notebook \
+            --output="tmp" \
+            "$f"
+
+    md5New=$(md5sum "$out" | cut -f 1 -d \  )
+
+    if [ "$md5New" == "$md5Orig" ]; then
+        rm "$out"
+    else
+        echo "Cleaned: $f"
+        mv "$out" "$f"
+    fi
+
+done

tests/data/Pythagoras.ipynb

@@ -13,7 +13,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [