feat(lint): add bash script to lint all scripts/notebooks more easily

Author: amyheather

.github/workflows/lint.yaml

@@ -23,18 +23,6 @@ jobs:
             cache: 'pip'
         - run: pip install -r requirements.txt
 
-        - name: Lint model code
+        - name: Lint
           run: |
-            pylint ./simulation
-
-        - name: Lint tests
-          run: |
-            pylint ./tests
-
-        - name: Lint notebooks
-          run: |
-            nbqa pylint ./notebooks
-
-        - name: Lint time-weighted averages notebook
-          run: |
-            nbqa pylint ./docs/time_weighted_averages.ipynb
+            bash lint.sh

README.md

@@ -174,6 +174,12 @@ You can lint the `.ipynb` by adding `nbqa` to the start of the command - e.g.:
 nbqa pylint notebooks/analysis.ipynb
 ```
 
+A bash script has been provided which can be used to lint all files in succession by running:
+
+```
+bash lint.sh
+```
+
 <br>
 
 ## ❓ How does the model work?
@@ -223,6 +229,7 @@ repo/
 ├── CONTRIBUTING.md       # Contribution instructions
 ├── environment.yaml      # Conda environment (includes Python version)
 ├── LICENSE               # Licence file
+├── lint.sh               # Bash script to lint all .py and .ipynb files at once
 ├── pyproject.toml        # Metadata for local `simulation/` package
 ├── README.md             # This file! Describes the repository
 └── requirements.txt      # Virtual environment (used by GitHub actions)

lint.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+echo "Linting model code..."
+pylint ./simulation
+
+echo "Linting tests..."
+pylint ./tests
+
+echo "Linting notebooks..."
+nbqa pylint ./notebooks
+
+echo "Linting time-weighted averages notebook..."
+nbqa pylint ./docs/time_weighted_averages.ipynb