release: v0.5.6

Add platform and Python version information to User-Agent headers

Author: nkarasiak

.github/workflows/ruff-mypy.yaml

@@ -0,0 +1,33 @@
+name: lint-format-type-check
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install "ruff>=0.9.6,<1.0.0" "mypy>=1.0.0,<2.0.0" "types-tqdm>=4.67,<5.0.0"
+
+      - name: Run Ruff Check
+        run: ruff check . --select I
+
+      - name: Run Ruff Format
+        run: ruff format --check .
+
+      - name: Run MyPy
+        run: mypy .

.github/workflows/ruff.yaml

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.6] - 2025-03-26
+
+### Added
+
+- platform and python version information to User-Agent headers.
+
 ## [0.5.5] - 2025-03-11
 
 ### Fixed

docs/CHANGELOG.md

@@ -10,7 +10,7 @@
 * Add description of your changes
 * Add and ensure tests are passing
 * Ensure branch is mergeable
-* If possible, ruff check your code :)
+* Use Ruff to format and lint your code
 
 ## Testing
 

docs/CONTRIBUTING.md

@@ -7,14 +7,14 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-# import re
+# mypy: ignore-errors
+# TODO (v1): Fix type issues and remove 'mypy: ignore-errors' after verifying non-breaking changes
+
 import os
-import sys
 import re
+import sys
 
-from sphinx_gallery.sorting import ExampleTitleSortKey
-import os
-os.environ['PYDEVD_DISABLE_FILE_VALIDATION'] = "1"
+os.environ["PYDEVD_DISABLE_FILE_VALIDATION"] = "1"
 project = "earthdaily"
 copyright = "2024, EarthDailyAgro"
 author = "Geosys/EarthDailyAgro"
@@ -24,16 +24,16 @@
 
 
 extensions = [
-    'sphinx.ext.autodoc',  # For automatic API documentation
-    'sphinx.ext.napoleon',  # For Google/NumPy style docstrings
-    'sphinx.ext.viewcode',  # To add links to source code
-    'sphinx_autodoc_typehints',  # For better type hint support
+    "sphinx.ext.autodoc",  # For automatic API documentation
+    "sphinx.ext.napoleon",  # For Google/NumPy style docstrings
+    "sphinx.ext.viewcode",  # To add links to source code
+    "sphinx_autodoc_typehints",  # For better type hint support
     "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
     "sphinx_gallery.gen_gallery",
     "sphinx_copybutton",
     "sphinx_automodapi.automodapi",
-    "sphinx_automodapi.smart_resolver",# for a page per function
+    "sphinx_automodapi.smart_resolver",  # for a page per function
     "myst_parser",
 ]
 #
@@ -119,4 +119,4 @@
 # -- Options for todo extension ----------------------------------------------
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
+todo_include_todos = False

docs/conf.py

@@ -1,12 +1,17 @@
-from typing import Optional
 from pathlib import Path
-from . import earthdatastore, datasets
-from .accessor import __EarthDailyAccessorDataArray, __EarthDailyAccessorDataset
+from typing import Optional
+
 from earthdaily.core import options
 
+from . import datasets, earthdatastore  # noqa: F401
+from .accessor import (  # noqa: F401
+    __EarthDailyAccessorDataArray,
+    __EarthDailyAccessorDataset,
+)
+
 __all__ = ["options"]
 
-__version__ = "0.5.5"
+__version__ = "0.5.6"
 
 
 def EarthDataStore(
@@ -47,6 +52,7 @@ def EarthDataStore(
         json_path=json_path,
         toml_path=toml_path,
         profile=profile,
+        client_version=__version__,
         presign_urls=presign_urls,
         asset_proxy_enabled=asset_proxy_enabled,
     )

earthdaily/__init__.py

@@ -1,15 +1,12 @@
-import warnings
-import xarray as xr
-import rioxarray as rxr
-import numpy as np
-import pandas as pd
 import geopandas as gpd
-from shapely.geometry import Point
-from dask import array as da
+import numpy as np
 import spyndex
+import xarray as xr
+from dask import array as da
 from dask_image import ndfilters as dask_ndimage
 from scipy import ndimage
-from xarray.core.extensions import AccessorRegistrationWarning
+from shapely.geometry import Point
+
 from ..earthdatastore.cube_utils import GeometryManager
 
 
@@ -99,7 +96,7 @@ def plot_band(self, cmap="Greys", col="time", col_wrap=5, **kwargs):
     def whittaker(
         self,
         beta: float = 10000.0,
-        weights: (np.ndarray, list) = None,
+        weights: np.ndarray | list | None = None,
         time="time",
     ):
         from . import whittaker
@@ -108,7 +105,7 @@ def whittaker(
 
     def sel_nearest_dates(
         self,
-        target: (xr.Dataset, xr.DataArray),
+        target: xr.Dataset | xr.DataArray,
         max_delta: int = 0,
         method: str = "nearest",
         return_target: bool = False,
@@ -159,7 +156,7 @@ def zonal_stats(
             With new dimension "zonal_statistics" and "geometry".
 
         """
-        from ..earthdatastore.cube_utils import zonal_stats, GeometryManager
+        from ..earthdatastore.cube_utils import GeometryManager, zonal_stats
 
         geometry = GeometryManager(geometry).to_geopandas()
         return zonal_stats(
@@ -181,7 +178,7 @@ def lee_filter(self, window_size: int):
             kwargs=dict(window_size=window_size),
         )
 
-    def centroid(self, to_wkt: str = False, to_4326: bool = True):
+    def centroid(self, to_wkt: bool = False, to_4326: bool = True):
         """Return the geographic center point in 4326/WKT of this dataset."""
         # we can use a cache on our accessor objects, because accessors
         # themselves are cached on instances that access them.

earthdaily/accessor/__init__.py

@@ -4,11 +4,9 @@
 @author: nkk
 """
 
-import xarray as xr
 import numpy as np
+import xarray as xr
 from scipy.linalg import solve_banded
-import warnings
-from dask import array as da
 
 
 def whittaker(dataset, beta=10000.0, weights=None, time="time"):

earthdaily/accessor/whittaker/__init__.py

@@ -3,7 +3,7 @@
 """
 
 import numpy as np
-from numba import types, guvectorize, njit, float64, int64
+from numba import float64, guvectorize, int64, njit, types
 
 
 def second_order_diff_matrix(x):

earthdaily/accessor/whittaker/_pywapor_core.py

@@ -4,8 +4,8 @@
 allowing users to set and retrieve options that affect package behavior.
 """
 
-from typing import Dict, Any, Optional, List, Callable
 from dataclasses import dataclass
+from typing import Any, Callable, Dict, List, Optional
 
 
 @dataclass
@@ -56,7 +56,7 @@ def validate(self, value: Any) -> bool:
         if self.valid_values is not None:
             if value not in self.valid_values:
                 raise ValueError(
-                    f"Invalid value: {value}. " f"Must be one of: {self.valid_values}"
+                    f"Invalid value: {value}. Must be one of: {self.valid_values}"
                 )
         return True
 

earthdaily/core/_options.py

@@ -1,4 +1,5 @@
 import os
+
 import geopandas as gpd
 
 __pathFile = os.path.dirname(os.path.realpath(__file__))