Skip to content

Commit 786c058

Browse files
committed
fix docs; min python 3.11 (soon needed for zarr v3); more pythons tested
1 parent ea19f3b commit 786c058

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

.github/workflows/test.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
strategy:
1919
fail-fast: false
2020
matrix:
21-
python: ["3.10", "3.12"]
21+
python: ["3.11", "3.12", "3.13", "3.14"]
2222
os: [ubuntu-latest]
2323

2424
env:

docs/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The advantage of a public specification is that it makes contributions and bugfi
3232

3333
The reader files are located under [src/spatialdata_io/readers](https://github.com/scverse/spatialdata-io/tree/main/src/spatialdata_io/readers). For each supported technology, the reader file is a single function, named after the technology, that takes as input the path to the raw data and extra arguments, and returns a `SpatialData` object:
3434

35-
```python=
35+
```python
3636
from pathlib import Path
3737
from spatialdata import SpatialData
3838

@@ -44,7 +44,7 @@ def technology(path: str | Path, ...) -> SpatialData:
4444

4545
For example, the reader for Xenium data, is called `xenium()` and is located under [`src/spatialdata_io/readers/xenium.py`](https://github.com/scverse/spatialdata-io/blob/main/src/spatialdata_io/readers/xenium.py).
4646

47-
#### Technical notes
47+
**Technical notes**
4848

4949
> Feel free to skip this section (and all the "technical notes") if you are doing a first read and just want an overview of the contribution process.
5050
@@ -114,7 +114,7 @@ There are a series of reasons to prefer public datasets provided with a permissi
114114

115115
If the data cannot be public yet, please reach out to scverse via [Zulip](https://scverse.zulipchat.com/#narrow/channel/443514-spatialdata-dev) via private message, or via email. Please give us access to a private repository where you can upload a `download.py` and `to_zarr.py` script working as described above. In alternative, you can also send us the data directly instead of the `download.py` script.
116116

117-
#### Technical notes
117+
**Technical notes**
118118

119119
If the `download.py` and `to_zarr.py` scripts require Python imports for packages that are not available in an environment where `spatialdata` is installed, please provide also a `requirement.txt` file (see for instance a [legacy one here](https://github.com/giovp/spatialdata-sandbox/blob/main/merfish/requirements.txt)), specify the dependencies in the scripts as [inline script metadata (PEP 723)](https://docs.astral.sh/uv/guides/scripts/#declaring-script-dependencies).
120120

@@ -154,7 +154,7 @@ Converters are not the primary scope of `spatialdata-io`, so we will just give s
154154

155155
The readers and converters from `spatialdata-io` can be invoked via the command line (see the [CLI documentation](https://spatialdata.scverse.org/projects/io/en/stable/cli.html)). This Python file defines the CLI: [src/spatialdata_io/**main**.py](https://github.com/scverse/spatialdata-io/blob/main/src/spatialdata_io/__main__.py). Please if you add or modify a reder or converter, update the CLI accordingly.
156156

157-
#### Technical notes
157+
**Technical notes**
158158

159159
- In the future we may consider to automatically generate the CLI from the readers and converters, [see more here](https://github.com/scverse/spatialdata-io/pull/239#issuecomment-2588005228).
160160
- Keeping the CLI code up-to-date could be a good task for the GitHub Copilot code agent. We will experiment with this in the future.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ dynamic= [
1010
]
1111
description = "SpatialData IO for common techs"
1212
readme = "README.md"
13-
requires-python = ">=3.10"
13+
requires-python = ">=3.11"
1414
license = {file = "LICENSE"}
1515
authors = [
1616
{name = "scverse"},

0 commit comments

Comments
 (0)