Merge pull request #190 from siapy/develop

Develop

Author: janezlapajne

.gitattributes

@@ -1,2 +1 @@
 * text=auto
-tests/data/* filter=lfs diff=lfs merge=lfs -text

.github/workflows/docs.yml

@@ -18,6 +18,9 @@ jobs:
         uses: actions/checkout@v4
       - name: Setup PDM
         uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: 3.10
+          cache: true
       - name: Install dependencies
         run: pdm install -G docs
       - name: Build MkDocs site

.github/workflows/publish.yml

@@ -36,6 +36,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: pdm-project/setup-pdm@v4
         with:
-          version: "head"
+          python-version: 3.10
+          cache: true
       - name: Publish package distributions to PyPI
         run: pdm publish

.github/workflows/test.yml

@@ -11,13 +11,20 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+      fail-fast: false
+
+    name: Test Python ${{ matrix.python-version }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        with:
-          lfs: true # This option ensures that Git LFS files are checked out
       - name: Setup PDM
         uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: true
       - name: Install dependencies
         run: pdm install
       - name: Lint code
@@ -27,6 +34,8 @@ jobs:
         run: ./scripts/test.sh "Coverage for ${{ github.sha }}"
       - name: Store coverage files
         uses: actions/upload-artifact@v4
+        # Only upload for Python 3.12
+        if: matrix.python-version == '3.12'
         with:
           name: coverage-html
           path: htmlcov

.gitignore

@@ -13,6 +13,6 @@ venv
 .history
 site
 dist
-tests/data
+tests/data/*
 docs/examples/data/*
-!docs/examples/data/.gitkeep
+!.gitkeep

.pre-commit-config.yaml

@@ -14,18 +14,20 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.1
+    rev: v0.9.10
     hooks:
       - id: ruff
         args:
           - --fix
+          - --config=pyproject.toml
+        files: ^(siapy|tests)/
       - id: ruff-format
   - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.23.0
+    rev: v8.24.0
     hooks:
       - id: gitleaks
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         additional_dependencies:

Makefile

@@ -30,6 +30,9 @@ lint: .pdm
 test: .pdm
 	./scripts/test.sh "Develop"
 
+.PHONY: flt ## Run format, lint, and test
+flt: format lint test
+
 .PHONY: codespell  ## Use Codespell to do spellchecking
 codespell: .pre-commit
 	pdm run pre-commit run codespell --all-files
@@ -47,24 +50,7 @@ update-branches:
 
 .PHONY: clean  ## Clear local caches and build artifacts
 clean:
-	rm -rf `find . -name __pycache__`
-	rm -f `find . -type f -name '*.py[co]'`
-	rm -f `find . -type f -name '*~'`
-	rm -f `find . -type f -name '.*~'`
-	rm -rf .pdm-build
-	rm -rf .mypy_cache
-	rm -rf .cache
-	rm -rf .pytest_cache
-	rm -rf .ruff_cache
-	rm -rf htmlcov
-	rm -rf *.egg-info
-	rm -f .coverage
-	rm -f .coverage.*
-	rm -rf build
-	rm -rf dist
-	rm -rf site
-	rm -rf docs/_build
-	rm -rf coverage.xml
+	./scripts/clean.sh
 
 .PHONY: generate-docs  ## Generate the docs
 generate-docs:
@@ -78,6 +64,10 @@ serve-docs:
 version:
 	python -c "import siapy; print(siapy.__version__)"
 
+.PHONY: compress-data  ## Compress the data files
+compress-data:
+	./scripts/compress-data.sh $(version)
+
 .PHONY: help  ## Display this message
 help:
 	@grep -E \

docs/api/entities/images.md

@@ -0,0 +1 @@
+::: siapy.entities.images.interfaces

docs/api/entities/images/interfaces.md

@@ -0,0 +1 @@
+::: siapy.entities.images.rasterio_lib