Merge pull request #106 from bcdev/forman-x-switch_to_ruff

Repo and package maintenance

Author: forman

.editorconfig

@@ -1,4 +1,4 @@
-# Copyright © 2023 Norman Fomferra
+# Copyright © 2024, 2025 Brockmann Consult
 # Permission granted under conditions of the MIT license,
 # see https://mit-license.org/
 

.flake8

@@ -28,12 +28,9 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install .[dev,doc]
-    - name: Lint with flake8
+    - name: Lint with ruff
       run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        ruff check
     - name: Test with pytest
       run: |
         pytest --cov=zappend

.github/workflows/tests.yml

@@ -1,3 +1,11 @@
+## Version 0.8.1 (in development)
+
+* Replaced dev tools black and flake8 by isort and ruff. 
+* Reformatted code and fixed linter issues.
+* Added `environment.yml` to setup a conda/mamba development environment. 
+* Updated copyright notice.
+
+
 ## Version 0.8.0 (from 2024-10-04)
 
 * Added module `zappend.contrib` that contributes functions to 

CHANGES.md

@@ -20,7 +20,9 @@ checklist are addressed in your PR.
 
 **PR checklist**
 
-* Format code using [black](https://black.readthedocs.io/) with default settings.
+* Format code using first [isort](https://pycqa.github.io/isort/) 
+  then [ruff](https://black.readthedocs.io/) with default settings
+  (`ruff format .`).
   Check also section [code style](#code-style) below.
 * Your change shall not break existing unit tests.
   `pytest` must run without errors.
@@ -38,10 +40,9 @@ checklist are addressed in your PR.
 ## Code style
 
 The `zappend` code compliant to [PEP-8](https://pep8.org/) except for a line 
-length of 88 characters as recommended by [black](https://black.readthedocs.io/).
-Since black is un-opinionated regarding the order of imports, 
-we use the following three import blocks separated by an empty 
-line:
+length of 88 characters as used by `ruff format`.
+We structure imports using three blocks separated by an empty 
+line and sort them using `isort` _before_ applying `ruff`:
 
 1. Python standard library imports, e.g., `os`, `typing`, etc
 2. 3rd-party imports, e.g., `xarray`, `zarr`, etc

CONTRIBUTING.md

@@ -9,7 +9,7 @@
 [![codecov](https://codecov.io/gh/bcdev/zappend/graph/badge.svg?token=B3R6bNmAUp)](https://codecov.io/gh/bcdev/zappend)
 [![PyPI Version](https://img.shields.io/pypi/v/zappend)](https://pypi.org/project/zappend/)
 [![Conda Version](https://anaconda.org/conda-forge/zappend/badges/version.svg)](https://anaconda.org/conda-forge/zappend)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v0.json)](https://github.com/charliermarsh/ruff)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bcdev/zappend/HEAD?labpath=examples%2Fzappend-demo.ipynb)
 [![GitHub License](https://img.shields.io/github/license/bcdev/zappend)](https://github.com/bcdev/zappend)
 

README.md

@@ -45,10 +45,11 @@ pytest --cov=zappend tests
 
 ### Code Style
 
-`zappend` source code is formatted using the [black](https://black.readthedocs.io/) tool.
+`zappend` source code is formatted using the 
+[ruff](https://github.com/charliermarsh/ruff) tool.
 
 ```bash
-black zappend
+ruff format .
 ```
 
 ### Documentation

docs/about.md

@@ -0,0 +1,34 @@
+name: zappend
+channels:
+  - conda-forge
+dependencies:
+  - python >=3.10
+  # Library Dependencies
+  - click
+  - dask
+  - fsspec
+  - jsonschema
+  - numcodecs
+  - numpy
+  - pyyaml
+  - xarray
+  - zarr >=2.18,<3
+  # Dev Dependencies
+  - isort
+  - pytest
+  - pytest-cov
+  - ruff
+  # Doc Dependencies
+  - mkdocs
+  - mkdocs-autorefs
+  - mkdocs-material
+  - mkdocstrings
+  - mkdocstrings-python
+  # Testing Datasets
+  - dask
+  - pandas
+  - pyproj
+  - netcdf4
+  - h5netcdf
+  - s3fs
+  - scipy

environment.yml

@@ -18,12 +18,10 @@
    "outputs": [],
    "source": [
     "import glob\n",
-    "import math\n",
     "import os\n",
     "import os.path\n",
     "import shutil\n",
     "\n",
-    "import numpy as np\n",
     "import xarray as xr"
    ]
   },
@@ -2951,10 +2949,7 @@
    "id": "e3b5f156-88c7-4ce1-908e-88ddc7b7e18c",
    "metadata": {},
    "outputs": [],
-   "source": [
-    "from IPython.display import Markdown\n",
-    "from zappend.config import get_config_schema"
-   ]
+   "source": []
   },
   {
    "cell_type": "code",
@@ -3023,7 +3018,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "config_path = f\"zappend-config.yaml\""
+    "config_path = \"zappend-config.yaml\""
    ]
   },
   {

examples/zappend-demo.ipynb

@@ -2,7 +2,7 @@ site_name: zappend
 repo_url: https://github.com/bcdev/zappend
 repo_name: bcdev/zappend
 
-copyright: Copyright © 2024 Brockmann Consult
+copyright: Copyright © 2024, 2025 Brockmann Consult and contributors
 
 nav:
     - Overview: index.md