Merge pull request #7477 from Michael-Girma/enhancement/issue-7476

Added pre-commit for linting purposes. Fixes #7476

Author: ThomasWaldmann

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/pycqa/flake8
+    rev: 6.0.0
+    hooks:
+    -   id: flake8
+        files: '(src|scripts|conftest.py)'

docs/development.rst

@@ -179,6 +179,13 @@ virtual env and run::
   pip install -r requirements.d/development.txt
 
 
+This project utilizes pre-commit to format and lint code before it is committed.
+Although pre-commit is installed when running the command above, the pre-commit hooks
+will have to be installed separately. Run this command to install the pre-commit hooks::
+
+  pre-commit install
+
+
 Running the tests
 -----------------
 

requirements.d/development.txt

@@ -10,3 +10,4 @@ pytest-cov
 pytest-benchmark
 Cython
 twine
+pre-commit