diff --git a/README.md b/README.md index f963942..2046e41 100644 --- a/README.md +++ b/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] +``` diff --git a/pyproject.toml b/pyproject.toml index f096267..ee1bf25 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,6 +14,7 @@ dependencies = [ "configobj", "tqdm", "PyYAML", + "pytest-qt", "scipy", "scikit-image", ] @@ -37,6 +38,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", @@ -47,6 +53,9 @@ dev = [ "pre-commit", "ruff", "setuptools_scm", + "pytest-qt", + "qtpy", + "PyQt5", ] slumrmio = [