Typesafe Splipy, again

.github/workflows/python-package.yml

@@ -3,14 +3,19 @@ name: Python package
 on:
   push:
     branches: [ master ]
+    tags: ['*']
   pull_request:
     branches: [ master ]
-  create:
-    tags:
   workflow_dispatch:
 
 jobs:
 
+  debug:
+    name: Debug
+    runs-on: ubuntu-latest
+    steps:
+      - uses: hmarr/debug-action@v3
+
   test:
     name: Test
     runs-on: ${{ matrix.os }}
@@ -19,9 +24,9 @@ jobs:
         python-version: ['3.9', '3.10', '3.11', '3.12']
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
@@ -40,14 +45,14 @@ jobs:
     name: Build wheels
     needs: [test]
     runs-on: ${{ matrix.os }}
-    if: github.event_name == 'create' && startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch'
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch'
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
           python-version: '3.9'
       - name: Install dependencies
@@ -59,41 +64,42 @@ jobs:
         env:
           CIBW_BUILD: cp39-* cp310-* cp311-* cp312-*
           CIBW_SKIP: '*musllinux* *i686*'
-          # CIBW_BEFORE_BUILD: pip install -r requirements.dev.txt
       - uses: actions/upload-artifact@v3
         with:
+          name: wheels-${{ matrix.os }}
           path: ./wheelhouse/*.whl
 
   build_sdist:
     name: Build sdist
     needs: [test]
     runs-on: ubuntu-latest
-    if: github.event_name == 'create' && startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch'
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch'
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
           python-version: '3.9'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip wheel poetry
       - name: Build sdist
         run: make sdist
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
+          name: sdist
           path: ./dist/*.tar.gz
 
   deploy:
     name: Deploy
     needs: [build_wheels, build_sdist]
     runs-on: ubuntu-latest
-    if: github.event_name == 'create' && startsWith(github.ref, 'refs/tags/v')
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
-          name: artifact
           path: dist
+          merge-multiple: true
       - uses: pypa/[email protected]
         with:
           user: __token__
@@ -105,10 +111,10 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event_name == 'workflow_dispatch'
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
-          name: artifact
           path: dist
+          merge-multiple: true
       - uses: pypa/[email protected]
         with:
           user: __token__

Makefile

@@ -1,36 +1,47 @@
-.PHONY: install mypy lint fmt fmtcheck doc
+package := splipy
 
-install:
-	poetry install --with=dev
 
-mypy:
-	poetry run mypy splipy
+# Convenience targets
 
-lint:
-	poetry run ruff splipy
+.PHONY: install
+install:
+	poetry install --with=dev
 
-bench:
-	poetry run pytest --benchmark-only
+.PHONY: doc
+doc:
+	$(MAKE) -C doc html
 
-fmt:
-	poetry run black splipy
-	poetry run isort splipy
 
-fmtcheck:
-	poetry run black splipy --check
-	poetry run isort splipy --check
+# Linting targets
 
+.PHONY: format
+format:
+	poetry run ruff format $(package)
 
-doc:
-	$(MAKE) -C doc html
+.PHONY: lint
+lint:
+	poetry run ruff check --fix $(package)
 
 
 # Test targets
 
+.PHONY:
+benchmark:
+	poetry run pytest --benchmark-only
+
 .PHONY: pytest
 pytest:
 	poetry run pytest --benchmark-skip
 
+.PHONY: mypy
+mypy:
+	poetry run mypy
+
+.PHONY: lint-check
+lint-check:
+	poetry run ruff check $(package)
+	poetry run ruff format --check $(package)
+
 .PHONY: examples
 examples:
 	poetry run python examples/circle_animation.py --ci
@@ -42,7 +53,7 @@ examples:
 	poetry run python examples/write.py
 
 .PHONY: test  # most common test commands for everyday development
-test: pytest
+test: pytest mypy lint-check
 
 .PHONY: test-all  # run from CI: the whole kitchen sink
 test-all: test examples

README.rst

@@ -75,6 +75,30 @@ Don't upload wheels to PyPI manually. They are built by CI runners whenever a
 new version is tagged (see below).
 
 
+Tests
+-----
+
+To run the tests, use::
+
+    make test
+
+To run specific parts of the tests, use::
+
+    make pytest
+    make mypy
+    make lint-check
+
+The lint-check stage of the tests will complain about linter and style errors.
+Some of these can be fixed automatically. To do this, run::
+
+    make lint
+    make format
+
+For benchmarks::
+
+    make benchmark
+
+
 Documentation
 -------------
 
@@ -89,18 +113,6 @@ To push generated docs online on the ``gh-pages`` branch, run the helper script:
 where ``remote`` is the name of the remote to push to. If not given, it will be asked.
 
 
-Tests
------
-
-To run the tests, use::
-
-    make test
-
-For benchmarks::
-
-    make bench
-
-
 Releasing
 ---------
 

examples/write.py

@@ -18,5 +18,5 @@
 
 
 # G2 files are native GoTools (http://www.sintef.no/projectweb/geometry-toolkits/gotools/)
-with G2('torus.g2') as my_file:
+with G2('torus.g2', 'w') as my_file:
     my_file.write(torus)