Skip to content

Commit

Permalink
Provide optional dependencies for qt instead of napari (#84)
Browse files Browse the repository at this point in the history
* provide qt optional dependencies instead of napari

* updated installaiton instructions in README accordingly
  • Loading branch information
niksirbi authored Jun 24, 2024
1 parent a64cd9a commit 9f87ec1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,16 @@ Shared general purpose tools for the BrainGlobe project, including [citation gen
pip install brainglobe-utils
```

To also include the dependencies required for `napari`, use:
To also include the dependencies required for Qt widgets, use:

```bash
pip install brainglobe-utils[napari]
pip install brainglobe-utils[qt]
```

For development, clone this repository and install the dependencies with one of the following commands:
For development, clone this repository and install the dependencies with:

```bash
pip install -e .[dev]
pip install -e .[dev,napari]
```

## Citations for BrainGlobe tools
Expand Down
7 changes: 3 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ 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", "superqt"]
qt = ["qtpy", "superqt"]

dev = [
"black",
Expand All @@ -60,13 +60,12 @@ dev = [
"pytest-qt",
"pytest-mock",
"pytest",
"qtpy",
"ruff",
"scikit-image",
"setuptools_scm",
"superqt",
"tox",
"pooch",
"brainglobe-utils[qt]",
]


Expand All @@ -85,7 +84,7 @@ exclude = ["tests", "docs*"]
addopts = "--cov=brainglobe_utils"

[tool.black]
target-version = ['py310','py311', 'py312']
target-version = ['py310', 'py311', 'py312']
skip-string-normalization = false
line-length = 79

Expand Down

0 comments on commit 9f87ec1

Please sign in to comment.