Skip to content

Commit f5076eb

Browse files
authored
Fix install "all extras" for Python 3.12 (#1219)
* remove CZI from webknossos[all] * updated cahngelog
1 parent 26e588a commit f5076eb

File tree

6 files changed

+12
-6
lines changed

6 files changed

+12
-6
lines changed

docs/src/webknossos-py/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ For extended file format conversation support it is necessary to install the opt
1717
pip install "webknossos[all]"
1818
```
1919

20-
If you have issues with installing the `pylibczirw` package on macOS, try:
20+
For working with Zeiss CZI microscopy data utilizing the`pylibczirw` package run:
2121

2222
```bash
23-
pip install --extra-index-url https://pypi.scm.io/simple/ "webknossos[all]"
23+
pip install --extra-index-url https://pypi.scm.io/simple/ "webknossos[czi]"
2424
```

webknossos/Changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ For upgrade instructions, please check the respective _Breaking Changes_ section
1717
### Added
1818

1919
### Changed
20+
Removed the CZI installation extra from `pip install webknossos[all]` by default. Users need to manually install it with `pip install --extra-index-url https://pypi.scm.io/simple/ webknossos[czi]`. [#1219](https://github.com/scalableminds/webknossos-libs/pull/1219)
2021

2122
### Fixed
2223

webknossos/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ You can install it from [pypi](https://pypi.org/project/webknossos/), e.g. via p
3636
pip install webknossos
3737
```
3838

39-
To install `webknossos` with the depencies for all examples, support for CZI files, and BioFormats conversions, run: `pip install webknossos[all]`.
39+
To install `webknossos` with the dependencies for all examples, support for more file types, and BioFormats conversions, run: `pip install webknossos[all]`.
40+
41+
For working with Zeiss CZI microscopy data use `pip install --extra-index-url https://pypi.scm.io/simple/ webknossos[czi]`.
4042

4143
By default `webknossos` can only distribute any computations through multiprocessing or Slurm. For Kubernetes or Dask install these additional dependencies:
4244

webknossos/pyproject.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ classifiers = [
2323
"Topic :: Scientific/Engineering :: Visualization",
2424
"Topic :: Software Development :: Libraries",
2525
"Typing :: Typed",
26+
"Programming Language :: Python :: 3.9",
27+
"Programming Language :: Python :: 3.10",
28+
"Programming Language :: Python :: 3.11",
29+
"Programming Language :: Python :: 3.12",
2630
]
2731

2832
requires-python = ">=3.9,<3.13"
@@ -81,7 +85,6 @@ all = [
8185
"webknossos[tifffile]",
8286
"webknossos[imagecodecs]",
8387
"webknossos[bioformats]",
84-
"webknossos[czi]",
8588
"webknossos[examples]",
8689
]
8790

webknossos/webknossos/dataset/_utils/pims_czi_reader.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
from pylibCZIrw import czi as pyczi
1111
except ImportError as e:
1212
raise ImportError(
13-
"Cannot import pylibCZIrw, please install it e.g. using 'webknossos[czi]'"
13+
"Cannot import pylibCZIrw, please install it e.g. using pip install --extra-index-url https://pypi.scm.io/simple/ webknossos[czi]"
1414
) from e
1515

1616
PIXEL_TYPE_TO_DTYPE = {

webknossos/webknossos/dataset/dataset.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -824,7 +824,7 @@ def from_images(
824824
825825
Note:
826826
This method needs extra packages like tifffile or pylibczirw.
827-
Install with `python -m pip install "webknossos[all]"`.
827+
Install with `pip install "webknossos[all]"` and `pip install --extra-index-url https://pypi.scm.io/simple/ "webknossos[czi]"`.
828828
"""
829829

830830
input_upath = UPath(input_path)

0 commit comments

Comments
 (0)