Skip to content
Merged
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
1 change: 1 addition & 0 deletions changes/4261.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The contents of the `zarr` source distribution are now defined by an explicit allowlist rather than a blocklist. Previously the sdist bundled the whole `packages/` tree — `zarr-indexing`, `zarr-metadata` and `zarr-http-server`, which are released as their own distributions — along with CI configuration and other repository files. The sdist also now ships `docs/`, so the test suite it carries can be collected and run from an unpacked sdist.
18 changes: 15 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,23 @@
requires = ["hatchling>=1.29.0", "hatch-vcs"]
build-backend = "hatchling.build"

# An allowlist, not a blocklist: anything new — a subpackage under `packages/`, a
# config file in the repository root — stays out of the sdist unless it is named
# here. Beyond `src` and `tests`, the entries are what keeps the shipped test
# suite and docs build runnable from an unpacked sdist: `tests/test_docs.py`
# walks `docs/` and `testpaths` collects `docs/user-guide`; the pages under
# `docs/user-guide/examples/` pull their source out of `examples/` via pymdownx
# snippet includes; `mkdocs.yml` and `mkdocs_hooks.py` let `mkdocs build` run
# too. `pyproject.toml`, `README.md`, `LICENSE.txt` and `.gitignore` are added by
# hatchling itself.
[tool.hatch.build.targets.sdist]
exclude = [
"/.github",
"/bench",
include = [
"/src",
"/tests",
"/docs",
"/examples",
"/mkdocs.yml",
"/mkdocs_hooks.py",
]

[project]
Expand Down
Loading