Merge pull request #342 from bas-amop/tz/ruff

Linting and pre-commit hooks

Author: thomaszwagerman

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  test:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install --group test
+          pip install .
+      - name: Run tests
+        run: pytest -m "not slow" -n auto

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files
+    - id: check-json
+    - id: check-toml
+    - id: check-merge-conflict
+    - id: debug-statements
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.14.10
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [--fix]
+    # Run the formatter.
+    - id: ruff-format

CHANGELOG.md

@@ -18,6 +18,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Enable running of tests in parallel using pytest-xdist (#260).
 - Add usage section to README.md (#321).
 - Add CHANGELOG.md, CONTRIBUTING.md, CITATION.cff, Makefile.
+- Linting with ruff.
+- Pre-commit hooks which checks linting, along with other formatting issues.
+- GitHub Actions test.yml.
 
 ### Changed
 - Account for SIC values being None, rather than absent in various vessel performance models (#245).

polar_route/__init__.py

@@ -11,10 +11,13 @@
     from meshiphi.dataloaders.factory import DataLoaderFactory as DataLoaderFactory
     from meshiphi.mesh_generation.boundary import Boundary as Boundary
 
-    from polar_route.vessel_performance.vessel_performance_modeller import VesselPerformanceModeller as VesselPerformanceModeller
-    from polar_route.vessel_performance.vessel_factory import VesselFactory as VesselFactory
+    from polar_route.vessel_performance.vessel_performance_modeller import (
+        VesselPerformanceModeller as VesselPerformanceModeller,
+    )
+    from polar_route.vessel_performance.vessel_factory import (
+        VesselFactory as VesselFactory,
+    )
     from polar_route.route_planner.route_planner import RoutePlanner as RoutePlanner
-    from polar_route.exceptions import WaypointOutOfBoundsError, NoRouteFoundError, InaccessibleWaypointError, RouteSmoothingError, InvalidMeshError
 
 except ModuleNotFoundError as err:
-    print(f'{err}\n Is PolarRoute installed correctly?')
+    print(f"{err}\n Is PolarRoute installed correctly?")