Merge pull request #3 from ecmwf-projects/feature/action_fixes

Feature/action fixes

Author: EddyCMWF

.cruft.json

@@ -9,6 +9,7 @@
       "project_short_description": "Polymorphism and duck-typing for geospatial data",
       "copyright_holder": "European Centre for Medium Range Weather Forecasts",
       "copyright_year": "2022",
+      "mypy_strict": "False",
       "_template": "https://github.com/ecmwf-projects/cookiecutter-conda-package"
     }
   },

.github/workflows/on-push.yml

@@ -48,7 +48,7 @@ jobs:
         python -m pip install --no-deps -e .
     - name: Run tests
       run: |
-        make test
+        make unit-tests
 
   type-check:
     needs: [unit-tests]
@@ -74,7 +74,7 @@ jobs:
         python -m pip install --no-deps -e .
     - name: Run code quality checks
       run: |
-        make type-check
+        echo type-check not used
 
   documentation:
     needs: [unit-tests]
@@ -100,7 +100,7 @@ jobs:
         python -m pip install --no-deps -e .
     - name: Build documentation
       run: |
-        make build-docs
+        make docs-build
 
   integration-tests:
     needs: [unit-tests]
@@ -132,7 +132,7 @@ jobs:
         python -m pip install --no-deps -e .
     - name: Run tests
       run: |
-        make test
+        make unit-tests
 
   distribution:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -36,7 +36,7 @@ repos:
   rev: v2.4.0
   hooks:
   - id: pretty-format-yaml
-    args: [--autofix]
+    args: [--autofix, --preserve-quotes]
   - id: pretty-format-toml
     args: [--autofix]
 - repo: https://github.com/PyCQA/pydocstyle.git

Makefile

@@ -3,16 +3,16 @@ CONDA := conda
 CONDAFLAGS :=
 COV_REPORT := html
 
-default: qa test type-check
+default: qa unit-tests type-check
 
 qa:
 	pre-commit run --all-files
 
-test:
+unit-tests:
 	python -m pytest -vv --cov=. --cov-report=$(COV_REPORT)
 
 type-check:
-	python -m mypy --strict .
+	python -m mypy .
 
 conda-env-update:
 	$(CONDA) env update $(CONDAFLAGS) -f environment.yml
@@ -26,5 +26,9 @@ docker-run:
 template-update:
 	pre-commit run --all-files cruft -c .pre-commit-config-weekly.yaml
 
-build-docs:
+docs-build:
 	cd docs && rm -fr _api && make clean && make html
+
+#integration-tests:
+#    python -m pytest -vv --cov=. --cov-report=$(COV_REPORT) tests/integration*.py
+#    python -m pytest -vv --doctest-glob='*.md'

README.md

@@ -24,7 +24,7 @@ Before pushing to GitHub, run the following commands:
 1. Run quality assurance checks: `make qa`
 1. Run tests: `make test`
 1. Run the static type checker: `make type-check`
-1. Build the documentation (see [Sphinx tutorial](https://www.sphinx-doc.org/en/master/tutorial/)): `make build-docs`
+1. Build the documentation (see [Sphinx tutorial](https://www.sphinx-doc.org/en/master/tutorial/)): `make docs-build`
 
 ## License
 

environment-minver.yml

@@ -5,3 +5,4 @@ dependencies:
 - make
 - pytest
 - pytest-cov
+- numpy

environment.yml

@@ -3,6 +3,7 @@ channels:
 - nodefaults
 dependencies:
 - make
+- mypy
 - myst-parser
 - pre-commit
 - pydata-sphinx-theme

setup.cfg

@@ -16,7 +16,15 @@ long_description = file: README.md
 
 [options]
 packages = find:
+install_requires =
+    numpy
+    xarray
+
 
 [flake8]
 max-line-length = 110
 extend-ignore = E203, W503
+
+[mypy]
+strict = False
+ignore_missing_imports = True