Switch to using the nox tool for driving linting and testing

Author: rwols

.github/workflows/ci.yml

@@ -24,11 +24,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install .
-          python -m pip install ruff
-      - name: Lint
-        run: python -m ruff check .
-      - name: Test with python unittest
-        run: python -m unittest
+        run: python -m pip --disable-pip-version-check install nox
+      - name: Lint & Test
+        run: nox

.github/workflows/publish.yml

@@ -10,7 +10,7 @@ name: Upload Python Package
 
 on:
   release:
-    types: [ published ]
+    types: [published]
 
 permissions:
   contents: read
@@ -25,9 +25,7 @@ jobs:
         with:
           python-version: '3.9'
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install build
+        run: python -m pip --disable-pip-version-check install build
       - name: Build package
         run: python -m build
       - name: Publish package

.gitignore

@@ -44,7 +44,9 @@ pip-delete-this-directory.txt
 
 # Unit test / coverage reports
 htmlcov/
+.nox/
 .tox/
+.ruff_cache/
 .coverage
 .coverage.*
 .cache

README.md

@@ -195,18 +195,27 @@ with \
 ```
 
 ## Documentation
+
 The full documentation is available in the `docs` folder with a readable version on [Read the Docs](https://trsfile.readthedocs.io/).
 
 ## Contributing
 
-### Testing
-The library supports Python `unittest` module and the tests can be executed with the following command:
-```
-python -m unittest
+Anyone is free to open a pull request.
+
+### Testing / Developing
+
+The library has tests and a linter has been set up for it. Both can be run with the following command:
+
+```sh
+nox
 ```
 
+Install the `nox` executable (in a virtual environment) using `python -m pip install -r ./requirements.txt`.
+
 ### Creating Releases
+
 We use Github Actions to publish packages to PYPy. Read the [Github docs on how to create a new release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) and trigger the publishing workflow:
 
 ## License
+
 [BSD 3-Clause Clear License](https://choosealicense.com/licenses/bsd-3-clause-clear/)

noxfile.py

@@ -0,0 +1,10 @@
+import nox
+import nox.project
+
+
+@nox.session(reuse_venv=True)
+def lint(session: nox.Session) -> None:
+    requirements = nox.project.load_toml("pyproject.toml")["project"]["optional-dependencies"]["DEV"]
+    session.install(*requirements)
+    session.run("ruff", "check")
+    session.run("python", "-m", "unittest", "discover")

pyproject.toml

@@ -29,10 +29,12 @@ dependencies = [
 
 [project.optional-dependencies]
 DEV = [
+  "m2r2",
+  "numpy",
+  "ruff",
   "sphinx",
   "sphinx-autobuild",
   "sphinx_rtd_theme",
-  "m2r2"
 ]
 
 [project.urls]

requirements.txt

@@ -0,0 +1 @@
+nox