added black dependency and instructions

IvoVellekoop · Oct 1, 2024 · efd9b7e · efd9b7e
1 parent 32c46de
commit efd9b7e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/STYLEGUIDE.md b/STYLEGUIDE.md
@@ -6,7 +6,9 @@
 
 # General
 
-- PyCharm autoformatting should be enabled to ensure correct formatting.
+- all .py files MUST be formatted with the 'black' autoformatter. This can be done by installing the 'black' package,
+  and running `black .` in the root directory. black is automatically installed when the development dependencies are
+  included.
 
 # Tests
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -59,6 +59,7 @@ optional = true
 scikit-image = ">=0.21.0"
 pytest = "~7.0.0"
 nidaq = "nidaqmx >=0.8.0" # we can test without the hardware, but still need the package
+black = ">=24.0.0" # code formatter
 
 [tool.poetry.group.docs]
 optional = true