Tidied up and fixed linting, licece and some minor issues see ticket for

full details

Author: Ben Cleary

.github/workflows/ci.yml

@@ -17,6 +17,23 @@ env:
   MPLCONFIGDIR: ${{ github.workspace }}/.mplconfig
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: uv sync --frozen --all-extras --group dev
+      - name: Run Ruff linter
+        run: uv run ruff check src/
+      - name: Run Ruff formatter check
+        run: uv run ruff format --check src/
+
   test:
     runs-on: ubuntu-latest
     strategy:
@@ -38,7 +55,7 @@ jobs:
 
   build:
     runs-on: ubuntu-latest
-    needs: [test]
+    needs: [lint, test]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5

.github/workflows/release.yml

@@ -0,0 +1,75 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+env:
+  UV_CACHE_DIR: ${{ github.workspace }}/.uv-cache
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Build sdist and wheel
+        run: uv build --sdist --wheel
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+  github-release:
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  # Uncomment this job if you want to publish to PyPI
+  # pypi-publish:
+  #   runs-on: ubuntu-latest
+  #   needs: [build]
+  #   environment:
+  #     name: pypi
+  #     url: https://pypi.org/project/dtm-differ
+  #   permissions:
+  #     id-token: write  # For trusted publishing
+  #   steps:
+  #     - uses: actions/download-artifact@v4
+  #       with:
+  #         name: dist
+  #         path: dist/
+  #
+  #     - name: Publish to PyPI
+  #       uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -6,6 +6,9 @@ dist/
 wheels/
 *.egg-info
 
+# macOS
+.DS_Store
+
 # Virtual environments
 .venv
 

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ben Cleary
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyproject.toml

@@ -1,16 +1,38 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
 [project]
 name = "dtm-differ"
 version = "0.1.0"
 description = "DTM Differ is a Python package for comparing Digital Terrain Models (DTMs). It provides a command-line interface for generating test DTMs and comparing them."
 readme = "README.md"
 requires-python = ">=3.13"
+license = {text = "MIT"}
+authors = [
+    {name = "Ben Cleary"}
+]
+keywords = ["geospatial", "dtm", "dem", "terrain", "change-detection", "gis"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: GIS",
+]
 dependencies = [
     "jinja2>=3.1.6",
     "rasterio>=1.4.4",
     "tqdm>=4.67.1",
     "xdem>=0.1.6",
 ]
 
+[project.urls]
+Homepage = "https://github.com/bencleary/dtm-differ"
+Repository = "https://github.com/bencleary/dtm-differ"
+Issues = "https://github.com/bencleary/dtm-differ/issues"
+
 [project.optional-dependencies]
 test = ["pytest>=7.0", "pytest-cov>=4.0"]
 
@@ -21,4 +43,31 @@ dtm-differ-generate-test-dtms = "dtm_differ.generate_test_dtms:generate_all_scen
 [dependency-groups]
 dev = [
     "pytest>=9.0.2",
+    "ruff>=0.8.0",
 ]
+
+[tool.ruff]
+line-length = 100
+target-version = "py313"
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+    "SIM", # flake8-simplify
+]
+ignore = [
+    "E501",    # line too long (handled by formatter)
+    "SIM108",  # ternary operators can reduce readability
+    "SIM102",  # nested ifs sometimes clearer than combined conditions
+    "SIM103",  # explicit return True/False can be clearer
+    "SIM117",  # nested with can be clearer for error handling
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"

src/dtm_differ/cli.py

@@ -5,6 +5,7 @@
 
 import xdem
 
+from dtm_differ import __version__
 from dtm_differ.db import Database
 from dtm_differ.pipeline import run_pipeline
 from dtm_differ.pipeline.types import ProcessingConfig
@@ -17,6 +18,7 @@ def build_parser() -> ArgumentParser:
     parser = ArgumentParser(
         prog="dtm-differ", description="Simple DTM differencing tool for GeoTIFFs"
     )
+    parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
 
     subparsers = parser.add_subparsers(dest="command", required=True)
 
@@ -33,9 +35,7 @@ def build_parser() -> ArgumentParser:
         "⚠️  WARNING: Assumes input DEMs use meter-based vertical units. "
         "Verify your DEM vertical units match this assumption.",
     )
-    run.add_argument(
-        "--style", choices=["diverging", "terrain", "greyscale"], default="diverging"
-    )
+    run.add_argument("--style", choices=["diverging", "terrain", "greyscale"], default="diverging")
 
     run.add_argument(
         "--uncertainty",
@@ -121,9 +121,7 @@ def parse_thresholds(raw: str | None) -> tuple[float, float, float]:
             return 1.0, values[0], values[1]
         if len(values) == 3:
             return values[0], values[1], values[2]
-        raise ValueError(
-            "Invalid --thresholds; expected 'amber,red' or 'green,amber,red'"
-        )
+        raise ValueError("Invalid --thresholds; expected 'amber,red' or 'green,amber,red'")
 
     db = Database(DATABASE_PATH)
     db.initialise()

src/dtm_differ/constants.py

@@ -6,4 +6,3 @@
 NODATA_DIRECTION: int = 127
 NODATA_RANK: int = 0
 NODATA_MASK: int = 255
-

src/dtm_differ/generate_test_dtms.py

@@ -31,7 +31,7 @@ def create_test_dem(
 
     # Prepare data: convert nodata to NaN to avoid warnings
     prepared_data = data.copy().astype(np.float32)
-    
+
     # Handle non-finite values first (NaN, inf)
     non_finite_mask = ~np.isfinite(prepared_data)
     if np.any(non_finite_mask):
@@ -40,7 +40,7 @@ def create_test_dem(
             prepared_data[non_finite_mask] = nodata
         else:
             prepared_data[non_finite_mask] = np.nan
-    
+
     # Convert nodata values to NaN before passing to xdem
     if nodata is not None:
         # Use np.isclose for floating point comparison to handle precision issues
@@ -317,11 +317,11 @@ def generate_scenario_7_mostly_nodata(out_dir: Path) -> None:
 def generate_scenario_8_no_nodata_attribute(out_dir: Path) -> None:
     """
     Scenario 8: DEMs without nodata attribute but with NaN/inf.
-    
+
     Tests:
     - DEMs with NaN values but no nodata attribute
     - DEMs with infinite values
-    
+
     Note: NaN/inf will be converted to NaN by create_test_dem, which is fine
     for testing how the pipeline handles non-finite values.
     """

src/dtm_differ/geotiff.py

@@ -3,11 +3,10 @@
 
 import numpy as np
 import rasterio
-from rasterio.errors import CRSError
-from rasterio.errors import RasterioIOError
+import xdem
+from rasterio.errors import CRSError, RasterioIOError
 
 from dtm_differ.types import GeoTiffBounds, GeotiffInformation, RasterCompatability
-import xdem
 
 
 def _normalize_linear_units_factor(value: object) -> float | None:
@@ -58,7 +57,7 @@ def validate_geotiff(geotiff_path: str) -> None:
             if src.crs is None:
                 raise ValueError("No CRS")
     except RasterioIOError as e:
-        raise ValueError(f"Invalid GeoTIFF file: {geotiff_path} - {e}")
+        raise ValueError(f"Invalid GeoTIFF file: {geotiff_path} - {e}") from e
 
 
 def get_geotiff_metadata(geotiff_path: str) -> tuple[GeotiffInformation, xdem.DEM]:
@@ -141,7 +140,7 @@ def check_raster_compatability(a: GeotiffInformation, b: GeotiffInformation) ->
 
     Returns:
         RasterCompatability: The compatibility of the two rasters
-    
+
     Throws:
         ValueError: If the two rasters are not compatible
     """
@@ -184,7 +183,7 @@ def reproject_raster(
 
     Throws:
         ValueError: If the direction is invalid
-    """    
+    """
     match direction:
         case "to-a":
             return b.reproject(ref=a, resampling=resampling)

src/dtm_differ/pipeline/__init__.py

@@ -32,9 +32,7 @@ def run_pipeline(
     if progress is True:
         progress_enabled = True
     elif progress is None:
-        progress_enabled = sys.stderr.isatty() and (
-            "PYTEST_CURRENT_TEST" not in os.environ
-        )
+        progress_enabled = sys.stderr.isatty() and ("PYTEST_CURRENT_TEST" not in os.environ)
 
     if defer_output is True:
         defer_output_enabled = True
@@ -57,9 +55,7 @@ def run_pipeline(
 
         # Stage-level progress; some stages (reprojection/polygonize/report) can take a long time.
         total_steps = 8
-        pbar = tqdm(
-            total=total_steps, desc="dtm-differ", unit="step", file=original_stderr
-        )
+        pbar = tqdm(total=total_steps, desc="dtm-differ", unit="step", file=original_stderr)
 
     def step(label: str) -> None:
         if pbar is None:
@@ -134,6 +130,8 @@ def step(label: str) -> None:
 
             if exc is None:
                 db.update_job_status(job_id, status="completed")
+        else:
+            db.update_job_status(job_id, status="completed")
 
     return ProcessingResult(
         job_id=job_id,
@@ -186,9 +184,7 @@ def _run_pipeline_steps(
 
     if config.generate_report:
         try:
-            stages.generate_report(
-                rasters, ws, config, a_info, b_info, job_id=ws.job_id
-            )
+            stages.generate_report(rasters, ws, config, a_info, b_info, job_id=ws.job_id)
         except Exception as e:
             warnings.warn(
                 f"Report generation failed: {e}. Check matplotlib installation and dependencies.",