Merge pull request #8 from alexlib/merge_openptv

Merge openptv

Author: alexlib

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/ecmwf-projects/cookiecutter-conda-package",
-  "commit": "a9c290fa0e810e9dee6c61991afac6f0c969c3b1",
+  "commit": "5ad0c955478c9b0fe8772545ef46291f5f314f75",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -13,7 +13,7 @@
       "integration_tests": "True",
       "pypi": true,
       "_template": "https://github.com/ecmwf-projects/cookiecutter-conda-package",
-      "_commit": "a9c290fa0e810e9dee6c61991afac6f0c969c3b1"
+      "_commit": "5ad0c955478c9b0fe8772545ef46291f5f314f75"
     }
   },
   "directory": null

.github/workflows/on-push.yml

@@ -22,20 +22,20 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
+    - uses: actions/checkout@v6
+    - uses: actions/setup-python@v6
       with:
-        python-version: 3.x
+        python-version: '3.12'
     - uses: pre-commit/action@v3.0.1
 
   combine-environments:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
+    - uses: actions/checkout@v6
+    - uses: actions/setup-python@v6
       with:
-        python-version: 3.x
+        python-version: '3.12'
     - name: Install conda-merge
       run: |
         python -m pip install conda-merge
@@ -44,7 +44,7 @@ jobs:
         for SUFFIX in ci integration; do
         conda-merge ci/environment-$SUFFIX.yml environment.yml > ci/combined-environment-$SUFFIX.yml || exit
         done
-    - uses: actions/upload-artifact@v4
+    - uses: actions/upload-artifact@v6
       with:
         name: combined-environments
         path: ci/combined-environment-*.yml
@@ -55,11 +55,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.11']
+        python-version: ['3.12', '3.13']
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/download-artifact@v4
+    - uses: actions/checkout@v6
+    - uses: actions/download-artifact@v7
       with:
         name: combined-environments
         path: ci
@@ -87,8 +87,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/download-artifact@v4
+    - uses: actions/checkout@v6
+    - uses: actions/download-artifact@v7
       with:
         name: combined-environments
         path: ci
@@ -103,7 +103,7 @@ jobs:
         cache-environment-key: environment-${{ steps.date.outputs.date }}
         cache-downloads-key: downloads-${{ steps.date.outputs.date }}
         create-args: >-
-          python=3.11
+          python=3.12
     - name: Install package
       run: |
         python -m pip install --no-deps -e .
@@ -116,8 +116,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/download-artifact@v4
+    - uses: actions/checkout@v6
+    - uses: actions/download-artifact@v7
       with:
         name: combined-environments
         path: ci
@@ -132,7 +132,7 @@ jobs:
         cache-environment-key: environment-${{ steps.date.outputs.date }}
         cache-downloads-key: downloads-${{ steps.date.outputs.date }}
         create-args: >-
-          python=3.11
+          python=3.12
     - name: Install package
       run: |
         python -m pip install --no-deps -e .
@@ -149,12 +149,12 @@ jobs:
     strategy:
       matrix:
         include:
-        - python-version: '3.11'
+        - python-version: '3.12'
           extra: -integration
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/download-artifact@v4
+    - uses: actions/checkout@v6
+    - uses: actions/download-artifact@v7
       with:
         name: combined-environments
         path: ci
@@ -188,10 +188,10 @@ jobs:
       (needs.integration-tests.result == 'success' || needs.integration-tests.result == 'skipped')
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
+    - uses: actions/checkout@v6
+    - uses: actions/setup-python@v6
       with:
-        python-version: '3.11'
+        python-version: '3.12'
     - name: Install package
       run: |
         python -m pip install --upgrade pip
@@ -206,7 +206,7 @@ jobs:
         python -m twine check --strict * || exit
         python -c "import openptv_python" || exit
         cd ..
-    - uses: actions/upload-artifact@v4
+    - uses: actions/upload-artifact@v6
       with:
         name: distribution
         path: dist
@@ -226,10 +226,10 @@ jobs:
       id-token: write  # IMPORTANT: this permission is mandatory for trusted publish
 
     steps:
-    - uses: actions/download-artifact@v4
+    - uses: actions/download-artifact@v7
       with:
         name: distribution
         path: dist
-    - uses: pypa/gh-action-pypi-publish@v1.12.4
+    - uses: pypa/gh-action-pypi-publish@v1.13.0
       with:
         verbose: true

.github/workflows/static.yml

@@ -31,13 +31,23 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v4
+    - name: Setup Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.12'
+    - name: Install documentation dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e ".[docs]"
+    - name: Build documentation
+      run: |
+        make docs-build
     - name: Setup Pages
       uses: actions/configure-pages@v4
     - name: Upload artifact
       uses: actions/upload-pages-artifact@v3
       with:
-          # Upload entire repository
-        path: '.'
+        path: docs/_build/html
     - name: Deploy to GitHub Pages
       id: deployment
       uses: actions/deploy-pages@v4

.gitignore

@@ -471,3 +471,5 @@ $RECYCLE.BIN/
 
 # End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks,vim,visualstudiocode,pycharm,emacs,linux,macos,windows
 .cruft.json
+/.tmp
+/tmp

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v5.0.0
+  rev: v6.0.0
   hooks:
   - id: trailing-whitespace
   - id: end-of-file-fixer
@@ -12,28 +12,29 @@ repos:
   - id: debug-statements
   - id: mixed-line-ending
 - repo: https://github.com/keewis/blackdoc
-  rev: v0.3.9
+  rev: v0.4.6
   hooks:
   - id: blackdoc
-    additional_dependencies: [black==23.11.0]
+    additional_dependencies: [black==25.9.0]
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.11.11
+  rev: v0.15.2
   hooks:
   - id: ruff
     args: [--fix, --show-fixes]
   - id: ruff-format
 - repo: https://github.com/executablebooks/mdformat
-  rev: 0.7.22
+  rev: 1.0.0
   hooks:
   - id: mdformat
 - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-  rev: v2.14.0
+  rev: v2.16.0
   hooks:
   - id: pretty-format-yaml
     args: [--autofix, --preserve-quotes]
   - id: pretty-format-toml
     args: [--autofix]
+    exclude: ^uv\.lock$
 - repo: https://github.com/gitleaks/gitleaks
-  rev: v8.26.0
+  rev: v8.30.0
   hooks:
   - id: gitleaks

Dockerfile

@@ -4,7 +4,7 @@ WORKDIR /src/openptv-python
 
 COPY environment.yml /src/openptv-python/
 
-RUN conda install -c conda-forge gcc python=3.11 \
+RUN conda install -c conda-forge gcc python=3.12 \
     && conda env update -n base -f environment.yml
 
 COPY . /src/openptv-python

Makefile

@@ -2,17 +2,18 @@ PROJECT := openptv_python
 CONDA := conda
 CONDAFLAGS :=
 COV_REPORT := html
+PYTHON ?= python
 
 default: qa unit-tests type-check
 
 qa:
-	pre-commit run --all-files
+	$(PYTHON) -m pre_commit run --all-files
 
 unit-tests:
-	python -m pytest -vv --cov=. --cov-report=$(COV_REPORT) --doctest-glob="*.md" --doctest-glob="*.rst"
+	$(PYTHON) -m pytest -vv --cov=. --cov-report=$(COV_REPORT) --doctest-glob="*.md" --doctest-glob="*.rst"
 
 type-check:
-	python -m mypy .
+	$(PYTHON) -m mypy .
 
 conda-env-update:
 	$(CONDA) install -y -c conda-forge conda-merge