Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 0 additions & 6 deletions .codespellrc

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v7
- name: Codespell
uses: codespell-project/actions-codespell@v2
9 changes: 3 additions & 6 deletions .github/workflows/validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ jobs:
name: Validation
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- run: python -mpip install --upgrade wheel tox
- run: tox
- uses: actions/checkout@v7
- uses: astral-sh/setup-uv@v9.0.0
- run: uv run --extra testing pytest -v
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ as well as [json schemas](./schemas) to validate written ome-zarr image data.

The built documentation including contribution hints can be found **[here](https://ngff-spec.readthedocs.io/en/latest/)**.

## Development

Use [`just`](https://github.com/casey/just) for common development tasks like building, linting, testing.
Run `just` to see a list of commands.

## Conformance tests

Conformance can be tested at several levels.
Expand Down
19 changes: 19 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
_:
just --list

# Build the specification in the _build/ directory.
build:
uv run python pre_build.py
uv run jupyter book build --html --ci

# Check spelling in the source files;
# configured in pyproject.toml.
spell:
uv run --extra testing codespell

# Run all lint commands.
lint: spell

# Run schema tests.
test:
uv run --extra testing pytest -v
6 changes: 4 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@ dependencies = [

[project.optional-dependencies]
testing = [
"tox",
"codespell",
"pytest", # https://docs.pytest.org/en/latest/contents.html
]

[tool.codespell]
ignore-regex = '\bComparin\b'
skip = ".git,.codespellrc,references.bib,.venv,.tox,*.css,_build"
ignore-words-list = "commend,Fuchsia"

[tool.hatch.version]
path = "_version.py"
Expand All @@ -30,4 +32,4 @@ packages = ["."]

[build-system]
requires = ["hatchling>=1.8.0,<1.21.1"]
build-backend = "hatchling.build"
build-backend = "hatchling.build"
3 changes: 2 additions & 1 deletion schemas/_version.schema
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"description": "OME-Zarr version.",
"type": "string",
"enum": [
"0.6rc0"
"0.6rc0",
"0.6"
]
}
10 changes: 0 additions & 10 deletions tox.ini

This file was deleted.

2,037 changes: 2,037 additions & 0 deletions uv.lock

Large diffs are not rendered by default.

Loading