Skip to content

Commit 8fe9262

Browse files
committed
ENH: Add all extras dep as a convenient alias
1 parent 7d18a8a commit 8fe9262

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

docs/installation.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ pip install ngff-zarr
1010

1111
:::
1212

13-
:::{tab-item} Browser via Pyodide, e.g. the [Pyodide REPL] or [JupyterLite]
13+
:::{tab-item} Browser via Pyodide
14+
15+
With, for example, the [Pyodide REPL] or [JupyterLite]
1416

1517
```python
1618
import micropip
@@ -21,6 +23,8 @@ await micropip.install('ngff-zarr')
2123

2224
::::
2325

26+
## Optional dependencies
27+
2428
Optional extras dependencies include:
2529

2630
`cli` : Additional IO libraries for
@@ -40,3 +44,17 @@ Optional extras dependencies include:
4044
[dask-image]: https://image.dask.org/en/latest/
4145
[itk]: https://docs.itk.org/en/latest/learn/python_quick_start.html
4246
[tensorstore]: https://google.github.io/tensorstore/
47+
48+
### Install all optional dependencies
49+
50+
To install all optional dependencies:
51+
52+
```shell
53+
pip install "ngff-zarr[cli,dask-image,itk,tensorstore,validate]"
54+
```
55+
56+
which is equivalent to:
57+
58+
```shell
59+
pip install "ngff-zarr[all]"
60+
```

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ validate = [
7878
"jsonschema"
7979
]
8080
docs = [ "furo>=2024.7.18,<2025", "myst-parser>=3.0.1,<4", "sphinx>=7.4.7,<8", "sphinx-autodoc2>=0.5.0,<0.6", "sphinx-copybutton>=0.5.2,<0.6", "sphinx-design>=0.6.0,<0.7", "sphinxext-opengraph>=0.9.1,<0.10", "sphinx-autobuild>=2024.4.16,<2025"]
81+
all = ["ngff-zarr[cli]", "ngff-zarr[docs]", "ngff-zarr[test]", "ngff-zarr[validate]", "ngff-zarr[tensorstore]"]
8182

8283

8384
[tool.coverage.report]

0 commit comments

Comments
 (0)