Merge pull request #2 from nasa/implement-pre-commit

.git-blame-ignore-revs

@@ -0,0 +1,5 @@
+# For more information, see:
+# https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view
+
+# Black code formatting of entire repository
+da4cd7af618fea30ab54052f6ccaa137c5471d82

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+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-json
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
+    hooks:
+      - id: ruff
+        args: ["--fix", "--show-fixes"]
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.3.0
+    hooks:
+      - id: black-jupyter
+        args: ["--skip-string-normalization"]
+        language_version: python3.11

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v1.0.1
+### 2024-04-05
+
+This version of the Swath Projector implements black code formatting across the
+entire repository. There should be no functional changes to the service.
+
 ## v1.0.0
 ### 2023-11-16
 

README.md

@@ -203,6 +203,39 @@ newest release of the code (starting at the top of the file).
 ## vX.Y.Z
 ```
 
+### pre-commit hooks:
+
+This repository uses [pre-commit](https://pre-commit.com/) to enable pre-commit
+checking the repository for some coding standard best practices. These include:
+
+* Removing trailing whitespaces.
+* Removing blank lines at the end of a file.
+* JSON files have valid formats.
+* [ruff](https://github.com/astral-sh/ruff) Python linting checks.
+* [black](https://black.readthedocs.io/en/stable/index.html) Python code
+  formatting checks.
+
+To enable these checks:
+
+```bash
+# Install pre-commit Python package as part of test requirements:
+pip install -r tests/pip_test_requirements.txt
+
+# Install the git hook scripts:
+pre-commit install
+
+# (Optional) Run against all files:
+pre-commit run --all-files
+```
+
+When you try to make a new commit locally, `pre-commit` will automatically run.
+If any of the hooks detect non-compliance (e.g., trailing whitespace), that
+hook will state it failed, and also try to fix the issue. You will need to
+review and `git add` the changes before you can make a commit.
+
+It is planned to implement additional hooks, possibly including tools such as
+`mypy`.
+
 ## Get in touch:
 
 You can reach out to the maintainers of this repository via email:

bin/project_local_granule.py

@@ -67,6 +67,7 @@
     function below can be edited.
 
 """
+
 from os import environ
 from unittest.mock import patch
 
@@ -77,10 +78,10 @@
 
 
 def set_environment_variables():
-    """ If the following environment variables are absent, the
-        `SwathProjectorAdapter` class will not allow the projector to run. Make
-        sure to run this script in a different environment (e.g. conda
-        environment) than any local instance of Harmony.
+    """If the following environment variables are absent, the
+    `SwathProjectorAdapter` class will not allow the projector to run. Make
+    sure to run this script in a different environment (e.g. conda
+    environment) than any local instance of Harmony.
 
     """
     environ['ENV'] = 'dev'
@@ -93,39 +94,48 @@ def set_environment_variables():
 
 
 def rmtree_side_effect(workdir: str, ignore_errors=True) -> None:
-    """ A side effect for the `shutil.rmtree` mock that will print the
-        temporary working directory containing all output NetCDF-4 files.
+    """A side effect for the `shutil.rmtree` mock that will print the
+    temporary working directory containing all output NetCDF-4 files.
 
     """
     print(f'\n\n\n\033[92mOutput files saved to: {workdir}\033[0m\n\n\n')
 
 
-def project_granule(local_file_path: str, target_crs: str = 'EPSG:4326',
-                    interpolation_method: str = 'near') -> None:
-    """ The `local_file_path` will need to be absolute, and prepended with
-        `file:///` to ensure that the `harmony-service-lib-py` package can
-        recognise it as a local file.
+def project_granule(
+    local_file_path: str,
+    target_crs: str = 'EPSG:4326',
+    interpolation_method: str = 'near',
+) -> None:
+    """The `local_file_path` will need to be absolute, and prepended with
+    `file:///` to ensure that the `harmony-service-lib-py` package can
+    recognise it as a local file.
 
-        The optional keyword arguments `target_crs` and `interpolation_method`
-        allow for a test that overrides the default message parameters of a
-        geographically projected output using nearest neighbour interpolation.
+    The optional keyword arguments `target_crs` and `interpolation_method`
+    allow for a test that overrides the default message parameters of a
+    geographically projected output using nearest neighbour interpolation.
 
     """
-    message = Message({
-        'callback': 'https://example.com/callback',
-        'stagingLocation': 's3://example-bucket/example-path',
-        'sources': [{
-            'granules': [{
-                'url': local_file_path,
-                'temporal': {
-                    'start': '2021-01-03T23:45:00.000Z',
-                    'end': '2020-01-04T00:00:00.000Z',
-                },
-                'bbox': [-180, -90, 180, 90],
-            }],
-        }],
-        'format': {'crs': target_crs, 'interpolation': interpolation_method},
-    })
+    message = Message(
+        {
+            'callback': 'https://example.com/callback',
+            'stagingLocation': 's3://example-bucket/example-path',
+            'sources': [
+                {
+                    'granules': [
+                        {
+                            'url': local_file_path,
+                            'temporal': {
+                                'start': '2021-01-03T23:45:00.000Z',
+                                'end': '2020-01-04T00:00:00.000Z',
+                            },
+                            'bbox': [-180, -90, 180, 90],
+                        }
+                    ],
+                }
+            ],
+            'format': {'crs': target_crs, 'interpolation': interpolation_method},
+        }
+    )
 
     set_environment_variables()
 

docker/service_version.txt

@@ -1 +1 @@
-1.0.0
+1.0.1