Reformatted files + pre-commit hook (#201)

* Reformatted files + pre-commit hook

* Update requirements

* Adds install instructions for the pre-commit hook

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.1.7
+    hooks:
+      # Run the linter.
+      - id: ruff
+      # Run the formatter.
+      - id: ruff-format

README.md

@@ -62,6 +62,14 @@ python -m pip install -e .
 python -m pip install -e ".[dev]"
 ```
 
+There is also a [pre-commit hook](https://pre-commit.com/#intro) available
+which formats the code and checks the linting before actually commiting.
+It can be installed with
+```shell
+pre-commit install
+```
+from the root of this repository.
+
 ## Test this software
 
 Especially relevant for developers, there exists a basic test framework written in

dev-requirements.txt

@@ -32,6 +32,8 @@ cattrs==23.2.2
     # via requests-cache
 certifi==2023.11.17
     # via requests
+cfgv==3.4.0
+    # via pre-commit
 charset-normalizer==3.3.2
     # via requests
 click==8.1.7
@@ -77,6 +79,8 @@ diffsims==0.5.2
     #   pyxem
 dill==0.3.7
     # via hyperspy
+distlib==0.3.7
+    # via virtualenv
 entrypoints==0.4
     # via ipyparallel
 exceptiongroup==1.2.0
@@ -91,6 +95,8 @@ fabio==2023.10.0
     #   silx
 fasteners==0.19
     # via zarr
+filelock==3.13.1
+    # via virtualenv
 flatdict==4.0.1
     # via pynxtools (pyproject.toml)
 fonttools==4.45.1
@@ -125,6 +131,8 @@ hyperspy==1.7.6
     #   kikuchipy
     #   pynxtools (pyproject.toml)
     #   pyxem
+identify==2.5.33
+    # via pre-commit
 idna==3.6
     # via requests
 ifes-apt-tc-data-modeling==0.1
@@ -236,6 +244,8 @@ nionutils==0.4.6
     #   nionswift
     #   nionswift-io
     #   nionui
+nodeenv==1.8.0
+    # via pre-commit
 numba==0.58.1
     # via
     #   diffsims
@@ -340,6 +350,7 @@ platformdirs==4.0.0
     #   jupyter-core
     #   pooch
     #   requests-cache
+    #   virtualenv
 pluggy==1.3.0
     # via pytest
 ply==3.11
@@ -348,6 +359,8 @@ pooch==1.8.0
     # via
     #   kikuchipy
     #   orix
+pre-commit==3.5.0
+    # via pynxtools (pyproject.toml)
 prettytable==3.9.0
     # via hyperspy
 prompt-toolkit==3.0.41
@@ -406,6 +419,7 @@ pyyaml==6.0.1
     #   dask
     #   hyperspy
     #   kikuchipy
+    #   pre-commit
     #   pynxtools (pyproject.toml)
 pyzmq==25.1.1
     # via
@@ -548,6 +562,8 @@ urllib3==2.1.0
     #   requests
     #   requests-cache
     #   types-requests
+virtualenv==20.25.0
+    # via pre-commit
 wcwidth==0.2.12
     # via
     #   prettytable