[feature] ignore tag (#61)

Author: alex-treebeard

.devcontainer/devcontainer.json

@@ -1,45 +1,45 @@
 {
-	"name": "Python 3",
-	"build": {
-		"dockerfile": "Dockerfile",
-		"context": "..",
-		"args": {
-			// Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9
-			"VARIANT": "3.8",
-			// Options
-			"INSTALL_NODE": "true",
-			"NODE_VERSION": "lts/*"
-		}
-	},
+  "name": "Python 3",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": "..",
+    "args": {
+      // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9
+      "VARIANT": "3.8",
+      // Options
+      "INSTALL_NODE": "true",
+      "NODE_VERSION": "lts/*"
+    }
+  },
 
-	// Set *default* container specific settings.json values on container create.
-	"settings": {
-		"terminal.integrated.shell.linux": "/bin/bash",
-		"python.pythonPath": "/usr/local/bin/python",
-		"python.linting.enabled": true,
-		"python.linting.pylintEnabled": true,
-		"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
-		"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
-		"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
-		"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
-		"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
-		"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
-		"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
-		"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
-		"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
-	},
+  // Set *default* container specific settings.json values on container create.
+  "settings": {
+    "terminal.integrated.shell.linux": "/bin/bash",
+    "python.pythonPath": "/usr/local/bin/python",
+    "python.linting.enabled": true,
+    "python.linting.pylintEnabled": true,
+    "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+    "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+    "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+    "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+    "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+    "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+    "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+    "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+    "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
+  },
 
-	// Add the IDs of extensions you want installed when the container is created.
-	"extensions": [
-		"ms-python.python"
-	],
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": [
+    "ms-python.python"
+  ],
 
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
 
-	// Use 'postCreateCommand' to run commands after the container is created.
-	// "postCreateCommand": "pip3 install --user -r requirements.txt",
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "pip3 install --user -r requirements.txt",
 
-	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
-	"remoteUser": "vscode"
+  // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode"
 }

.pre-commit-config.yaml

@@ -3,6 +3,12 @@ repos:
     rev: v3.3.0
     hooks:
     -   id: trailing-whitespace
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.1.10
+    hooks:
+    - id: remove-crlf
+    - id: remove-tabs
+      args: [ '--whitespaces-count', '2' ]
   - repo: https://github.com/kynan/nbstripout
     rev: master
     hooks:

README.md

@@ -23,15 +23,15 @@ pip install pytest nbmake
 pytest --nbmake **/*ipynb
 ```
 
-## Allow errors and Configure Cell Timeouts
+## Configure Cell Timeouts
 
 You can configure the cell timeout with the following pytest flag:
 
 ```sh
 pytest --nbmake --nbmake-timeout=3000 # allows each cell 3000 seconds to finish
 ```
 
-Each notebook can also be separately overidden to allow errors and fail if running exceeds a timeout.
+## Allow Errors For a Whole Notebook
 
 This configuration must be placed in the notebook's **top-level metadata** (not cell-level metadata).
 
@@ -50,6 +50,40 @@ Your notebook should look like this:
 }
 ```
 
+## Allow a Cell to Throw an Exception
+
+A cell with the following metadata can throw an exception without failing the test:
+
+```json
+{
+  "language": "python",
+  "custom": {
+    "metadata": {
+      "tags": [
+        "raises-exception"
+      ]
+    }
+  }
+}
+```
+
+## Ignore a Code Cell
+
+A cell with the following metadata will not be executed by nbmake
+
+```json
+{
+  "language": "python",
+  "custom": {
+    "metadata": {
+      "tags": [
+        "skip-execution"
+      ]
+    }
+  }
+}
+```
+
 ## Override Notebook Kernels when Testing
 
 Regardless of the kernel configured in the notebook JSON, you can force nbmake to use a specific kernel when testing: