Merge branch 'main' into bg-utils-hackathon

README.md

@@ -1,2 +1,18 @@
 # brainglobe-utils
 Shared general purpose tools for the BrainGlobe project
+
+## Installation
+
+```bash
+pip install brainglobe-utils
+```
+To also include the dependencies required for `napari`, use:
+```bash
+pip install brainglobe-utils[napari]
+```
+
+For development, clone this repository and install the dependencies with one of the following commands:
+```bash
+pip install -e .[dev]
+pip install -e .[dev,napari]
+```

pyproject.toml

@@ -14,6 +14,7 @@ dependencies = [
     "configobj",
     "tqdm",
     "PyYAML",
+    "pytest-qt",
     "scipy",
     "scikit-image",
     "superqt",
@@ -38,6 +39,11 @@ source_code = "https://github.com/brainglobe/brainglobe-utils"
 user_support = "https://github.com/brainglobe/brainglobe-utils/issues"
 
 [project.optional-dependencies]
+napari = [
+  "napari>=0.4.18",
+  "qtpy",
+]
+
 dev = [
   "pytest",
   "pytest-cov",
@@ -48,6 +54,9 @@ dev = [
   "pre-commit",
   "ruff",
   "setuptools_scm",
+  "pytest-qt",
+  "qtpy",
+  "PyQt5",
 ]
 
 slumrmio = [