Add pre-commit hooks to automatically format code on git commit (#18)

* Add pre-commit hooks and run hooks on all files * docs: Update pre-commit install instruction Addresses #18 (comment) --------- Co-authored-by: Jordan Gillard <[email protected]>
bellingcat · Jul 1, 2024 · 9d5bfcf · 9d5bfcf
1 parent 1144c59
commit 9d5bfcf
Show file tree

Hide file tree

Showing 8 changed files with 186 additions and 4 deletions.
diff --git a/.github/workflows/pypi-publish.yaml b/.github/workflows/pypi-publish.yaml
@@ -14,4 +14,4 @@ jobs:
         uses: JRubics/[email protected]
         with:
           pypi_token: ${{ secrets.PYPI_TOKEN }}
-          python_version: 3.9
+          python_version: 3.9
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,6 @@ venv.bak/
 *.png
 
 **/.DS_Store
+
+# IDE config
+.idea/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,14 @@
+# 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
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 24.2.0
+    hooks:
+    -   id: black
diff --git a/README.md b/README.md
@@ -105,6 +105,9 @@ pip install poetry
 # Install dependencies
 poetry install
 
+# Setup pre-commit hooks
+poetry run pre-commit install
+
 # Run the tool
 poetry run shadowfinder --help
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -35,6 +35,7 @@ pytz = "^2024.1"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.2.0"
+pre-commit = "^3.7.1"
 
 
 [build-system]

diff --git a/shadowfinder/shadowfinder.py b/shadowfinder/shadowfinder.py
@@ -66,7 +66,7 @@ def set_details(
         # either height or angle must be set (but not both or neither)
         # fmt: off
         valid_input = (
-            ((object_height is None) == (shadow_length is None)) and 
+            ((object_height is None) == (shadow_length is None)) and
             ((object_height is None) or (sun_altitude_angle is None))
         )
         # fmt: on

diff --git a/timezone_grid.json b/timezone_grid.json