Add example notebook (#709)

Author: mtsokol

.github/workflows/ci.yml

@@ -41,7 +41,7 @@ jobs:
           cache: 'pip'
       - name: Install package
         run: |
-          pip install -e .[tests]
+          pip install -e '.[tests]'
           if [ "${{ matrix.pip_opts }}" != "" ]; then
             pip install "${{ matrix.pip_opts }}" numba
           fi
@@ -65,7 +65,7 @@ jobs:
           cache: 'pip'
       - name: Install package
         run: |
-          pip install -e .[docs]
+          pip install -e '.[docs]'
       - name: Run tests
         run: |
           sphinx-build -W -b html docs/ _build/html
@@ -103,10 +103,26 @@ jobs:
     - name: Build and install Sparse
       run: |
         pip install -U setuptools wheel
-        python -m pip install '.[finch]' scipy
+        pip install '.[finch]' scipy
     - name: Run examples
       run: |
         source ci/test_examples.sh
+  notebooks:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+        cache: 'pip'
+    - name: Build and install Sparse
+      run: |
+        pip install -e '.[notebooks]'
+    - name: Run notebooks
+      run: |
+        source ci/test_notebooks.sh
   array_api_tests:
     strategy:
       matrix:
@@ -130,10 +146,10 @@ jobs:
         cache: 'pip'
     - name: Install build and test dependencies from PyPI
       run: |
-        python -m pip install pytest-xdist -r array-api-tests/requirements.txt
+        pip install pytest-xdist -r array-api-tests/requirements.txt
     - name: Build and install Sparse
       run: |
-        python -m pip install '.[finch]'
+        pip install '.[finch]'
     - name: Run the test suite
       env:
         ARRAY_API_TESTS_MODULE: sparse

.pre-commit-config.yaml

@@ -15,6 +15,7 @@ repos:
     - id: no-commit-to-branch
     - id: pretty-format-json
       args: ["--autofix", "--no-ensure-ascii"]
+      exclude: ".ipynb"
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: v0.4.10
@@ -24,3 +25,8 @@ repos:
       types_or: [ python, pyi, jupyter ]
     - id: ruff-format
       types_or: [ python, pyi, jupyter ]
+
+- repo: https://github.com/kynan/nbstripout
+  rev: 0.7.1
+  hooks:
+    - id: nbstripout

ci/test_notebooks.sh

@@ -0,0 +1 @@
+CI_MODE=True pytest -n 4 --nbmake --nbmake-timeout=600 ./examples/*.ipynb