Use ruff formatter as pre-commit (#65)

* Use ruff formatter as pre-commit

* Update usage docs

.github/workflows/linter.yml

@@ -14,10 +14,10 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up Python 3.8
+    - name: Set up Python 3.10
       uses: actions/setup-python@v4
       with:
-        python-version: '3.8'
+        python-version: '3.10'
 
     - name: Install pre-commit hooks
       run: |

.pre-commit-config.yaml

@@ -9,13 +9,15 @@
 #
 #
 default_language_version:
-  python: python3.8
+  python: python3.10
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.276
+    rev: v0.1.8
     hooks:
       - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.4
     hooks:

CONTRIBUTING.rst

@@ -41,7 +41,7 @@ Coding Convention
 -----------------
 
 We follow the PEP8_ convention for Python code
-and check for correct syntax with ruff_.
+and use ruff_ as a linter and code formatter.
 In addition,
 we check for common spelling errors with codespell_.
 Both tools and possible exceptions
@@ -61,13 +61,14 @@ You can also install ruff_ and codespell_
 and call it directly::
 
     pip install ruff codespell  # consider system wide installation
-    ruff check .
+    ruff check --fix .  # lint all Python files, and fix any fixable errors
+    ruff format .  # format code of all Python files
     codespell
 
 It can be restricted to specific folders::
 
-    ruff check audfoo/ tests/
-    codespell audfoo/ tests/
+    ruff check audplot/ tests/
+    codespell audplot/ tests/
 
 
 .. _codespell: https://github.com/codespell-project/codespell/

audplot/__init__.py

@@ -17,6 +17,7 @@
 # Dynamically get the version of the installed module
 try:
     import importlib.metadata
+
     __version__ = importlib.metadata.version(__name__)
 except Exception:  # pragma: no cover
     importlib = None  # pragma: no cover