Merge pull request #531 from adrn/pre-commit

Add pre-commit config

Author: adrn

.github/dependabot.yml

@@ -3,4 +3,4 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "weekly"

.github/workflows/build.yml

@@ -25,8 +25,7 @@ jobs:
         run: |
           sudo apt-get install pandoc
           python -m pip install -U pip
-          python -m pip install -r requirements.txt
-          python -m pip install git+https://github.com/astropy/nbcollection
+          python -m pip install -r requirements-dev.txt
 
       - name: Execute the notebooks
         run: |

.github/workflows/prs.yml

@@ -29,9 +29,7 @@ jobs:
         run: |
           sudo apt-get install pandoc
           python -m pip install -U pip
-          python -m pip install -r requirements.txt
-          python -m pip install gitpython
-          python -m pip install git+https://github.com/astropy/nbcollection
+          python -m pip install -r requirements-dev.txt
 
       # Run all tutorials if the label is present
       - name: Run all tutorials

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+        exclude: '.*\.fits$'
+    -   id: end-of-file-fixer
+        exclude_types: [csv]
+        exclude: '.*\.fits$'
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/kynan/nbstripout
+    rev: 0.5.0
+    hooks:
+    -   id: nbstripout
+        args: ["--extra-keys='metadata.kernelspec metadata.language_info.version metadata.toc'"]

Makefile

@@ -6,6 +6,10 @@ MODIFIED := $(shell python .github/get_modified_tutorials.py --main-branch $(TUT
 FLAGS = --flatten --build-path=. -v
 CONVERTFLAGS = --make-index --preprocessors=nbconvert.preprocessors.ExtractOutputPreprocessor --index-template=templates/index.tpl
 
+init:
+	python -m pip install -U -r requirements-dev.txt
+	pre-commit install
+
 build: envcheck execute convert
 buildall: envcheck executeall convertall
 
@@ -27,4 +31,4 @@ convertall:
 clean:
 	rm -rf _build
 
-.PHONY: all clean execute convert executeall convertall build buildall
+.PHONY: init all clean execute convert executeall convertall build buildall

requirements-dev.txt

@@ -0,0 +1,4 @@
+-r requirements.txt
+gitpython
+git+https://github.com/astropy/nbcollection
+pre-commit

templates/index.tpl

@@ -11,4 +11,4 @@
 {% endfor %}
 </ul>
 </body>
-</html>
+</html>

tutorials/FITS-cubes/FITS-cubes.ipynb

@@ -825,11 +825,6 @@
   }
  ],
  "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
@@ -839,21 +834,7 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.8.3"
-  },
-  "toc": {
-   "base_numbering": 1,
-   "nav_menu": {},
-   "number_sections": true,
-   "sideBar": true,
-   "skip_h1_title": false,
-   "title_cell": "Table of Contents",
-   "title_sidebar": "Contents",
-   "toc_cell": false,
-   "toc_position": {},
-   "toc_section_display": true,
-   "toc_window_display": false
+   "pygments_lexer": "ipython3"
   }
  },
  "nbformat": 4,

tutorials/FITS-header/FITS-header.ipynb

@@ -64,9 +64,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "scrolled": true
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "hdu_number = 0 # HDU means header data unit\n",
@@ -244,11 +242,6 @@
    "name": "",
    "published": true
   },
-  "kernelspec": {
-   "display_name": "Python 3",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
@@ -258,8 +251,7 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.6.7"
+   "pygments_lexer": "ipython3"
   }
  },
  "nbformat": 4,

tutorials/FITS-images/FITS-images.ipynb

@@ -451,11 +451,6 @@
    "name": "",
    "published": true
   },
-  "kernelspec": {
-   "display_name": "Python 3",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
@@ -465,8 +460,7 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.6.7"
+   "pygments_lexer": "ipython3"
   }
  },
  "nbformat": 4,