Metadata-Version: 2.4
Name: afolio
Version: 0.1.0
Summary: Chunked scientific arrays with JSON records and integrity manifests
Author: Mengzhao Wang
Author-email: Mengzhao Wang <mengzhao_wang@foxmail.com>
License-Expression: MIT
License-File: LICENSE
Requires-Dist: numpy>=2
Requires-Dist: zarr>=3,<4
Requires-Dist: ngff-zarr[validate]>=0.49.0,<0.50 ; extra == 'ome'
Requires-Dist: fsspec>=2026.9 ; extra == 'remote'
Requires-Dist: paramiko>=4 ; extra == 'remote'
Requires-Dist: tifffile>=2026.9.20 ; extra == 'tiff'
Requires-Python: >=3.13
Project-URL: Homepage, https://github.com/mz-wang/afolio
Project-URL: Repository, https://github.com/mz-wang/afolio
Project-URL: Documentation, https://github.com/mz-wang/afolio/tree/main/docs
Project-URL: Issues, https://github.com/mz-wang/afolio/issues
Provides-Extra: ome
Provides-Extra: remote
Provides-Extra: tiff
Description-Content-Type: text/markdown

# afolio

Store named scientific arrays with optional JSON records and explicit SHA-256 integrity checks.
The local storage uses standard Zarr v3; arrays remain readable without afolio.
Python 3.13 or newer is required.

Released under the [MIT License](LICENSE).

```powershell
uv sync --all-extras --managed-python
uv run python examples/local_dataset.py
```

For another uv project in a sibling directory, add this checkout with
`uv add ../afolio --extra tiff --extra ome` (adjust the checkout path as needed).
The package has not been published to PyPI.

Read the [getting started guide](docs/getting-started.md),
[API reference](docs/api.md), [disk format](docs/format.md), and
[OME-Zarr and TIFF guide](docs/image-formats.md).
Read-only SFTP access is described in the [remote guide](docs/remote.md).
Development decisions and progress live in [memo/](memo/2026-10-09-implementation.md).
See [development setup](docs/development.md) for Git hooks and verification commands.

The current implementation supports local datasets, stage records, integrity checks,
TIFF/OME-TIFF exports, optional OME-Zarr 0.5 image reading/writing, and read-only SFTP
access with connection reuse, bounded memory/disk caching and ROI prefetch. Trusted signatures, remote writes
and pyramid generation are planned extensions.
