Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Provide optional dependencies for qt instead of napari #84

Merged
merged 2 commits into from
Jun 24, 2024
Merged

Provide optional dependencies for qt instead of napari #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e920f1
provide qt optional dependencies instead of napari
niksirbi Jun 13, 2024
52a8fdc
updated installaiton instructions in README accordingly
niksirbi Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading