implement scripts for tutorial_i (#535)

BasisResearch · Apr 12, 2024 · af79c20 · af79c20
1 parent 9ea3f16
commit af79c20
Show file tree

Hide file tree

Showing 5 changed files with 464 additions and 282 deletions.
diff --git a/Makefile b/Makefile
@@ -1,9 +1,15 @@
 lint: FORCE
 	./scripts/lint.sh
 
+lint-notebooks:
+	./scripts/lint_notebooks.sh
+
 format:
 	./scripts/clean.sh
 
+format-notebooks:
+	./scripts/clean_notebooks.sh
+
 tests: lint FORCE
 	pytest -v tests
 

diff --git a/docs/source/tutorial_i.ipynb b/docs/source/tutorial_i.ipynb
diff --git a/scripts/clean_notebooks.sh b/scripts/clean_notebooks.sh
@@ -0,0 +1,9 @@
+#!/bin/bash
+
+INCLUDED_NOTEBOOKS="docs/source/tutorial_i.ipynb" # docs/source/backdoor.ipynb docs/source/dr_learner.ipynb docs/source/mediation.ipynb docs/source/sdid.ipynb docs/source/slc.ipynb docs/source/dynamical_intro.ipynb docs/source/actual_causality.ipynb"
+
+export ISORT_PROFILE=black
+
+nbqa isort $INCLUDED_NOTEBOOKS
+nbqa black $INCLUDED_NOTEBOOKS
+
diff --git a/scripts/lint_notebooks.sh b/scripts/lint_notebooks.sh
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+INCLUDED_NOTEBOOKS="docs/source/tutorial_i.ipynb" # docs/source/backdoor.ipynb docs/source/dr_learner.ipynb docs/source/mediation.ipynb docs/source/sdid.ipynb docs/source/slc.ipynb docs/source/dynamical_intro.ipynb docs/source/actual_causality.ipynb"
+
+export ISORT_PROFILE=black
+
+nbqa mypy --ignore-missing-imports $INCLUDED_NOTEBOOKS
+nbqa isort --check --diff $INCLUDED_NOTEBOOKS
+nbqa black --check $INCLUDED_NOTEBOOKS
+nbqa flake8 $INCLUDED_NOTEBOOKS
diff --git a/setup.py b/setup.py
@@ -61,6 +61,7 @@
             "myst_parser",
             "nbsphinx",
             "nbval",
+            "nbqa",
         ],
     },
     python_requires=">=3.8",