refkv: reference-aware key-value storage
refkv defines reference semantics for key-value storage. This allows an object
in one key-value store to refer to a byte range, or sequence of byte ranges,
in other storage backends (spec). refkv is used to define
vzip, a single-file reference-aware storage solution: a .vzip archive keeps
a reference store in one ordinary ZIP file
(its binding).
This package holds reference stores in memory, reads and writes vzip archives, and virtualizes TIFF, NDPI, ND2, CZI, DICOM, NIfTI and Imaris files, N5, Zarr v2 and OME-Zarr stores, and Sentinel-2 SAFE products through its Rust core, without copying their pixels (docs).
from refkv.virtualize import virtualize
store = virtualize("https://example.org/slide.ndpi") # a refkv.ReferenceStore
store.save("slide.vzip") # one vzip archive
For netCDF, HDF5 and the other files
VirtualiZarr reads,
refkv.ReferenceStore.from_virtualizarr(vds) turns a virtual dataset into a
store that xarray opens (example).
pip install refkv # read, write, virtualize
pip install "refkv[zarr]" # refkv.zarr: open a store with zarr-python and xarray
pip install "refkv[images]" # and the JPEG, JPEG 2000 and JPEG XR codecs
pip install "refkv[virtualizarr]" # virtual datasets from VirtualiZarr
Wheels are built for Linux and macOS (Python 3.12 and later); Windows is not supported yet.
Status: experimental, anything can change. Source, spec and issues: https://github.com/d-v-b/refkv.
1 maintainer
Metadata
1 maintainer
Release files for refkv 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| refkv-0.1.0.tar.gz | 527.2 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| refkv-0.1.0-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.12 | abi3 | Linux glibc 2.17+ x86-64 | Details |
| refkv-0.1.0-cp312-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl | CPython 3.12 | abi3 | Linux glibc 2.17+ ARM64 | Details |
| refkv-0.1.0-cp312-abi3-macosx_11_0_arm64.whl | CPython 3.12 | abi3 | macOS 11.0+ ARM64 | Details |
| refkv-0.1.0-cp312-abi3-macosx_10_12_x86_64.whl | CPython 3.12 | abi3 | macOS 10.12+ x86-64 | Details |
Total release size: 9.4 MB
Release files / refkv-0.1.0.tar.gz
| Download URL | refkv-0.1.0.tar.gz |
|---|---|
| Size | 527.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
18ec92ac33998b435c8bfca2ed6c4433626da43c9564194547478e320fc89a27
|
|
BLAKE2b-256 checksum How to use checksums |
dd5a98559ea156029ab8d9e02a0b24291d50c40c31291ead1bd90869e6e77efa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency logRelease files / refkv-0.1.0-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | refkv-0.1.0-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 2.3 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
484a0dbf94fbe5c66eadafcc69ffd1c78ba6c8a3c592562ff1ea40e05feb71dc
|
|
BLAKE2b-256 checksum How to use checksums |
aed2e89acad025e9c00f78457ebf4369890ff62f86029ffad8c80aeb60891e87
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency logRelease files / refkv-0.1.0-cp312-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | refkv-0.1.0-cp312-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
|---|---|
| Size | 2.2 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
c8bcc146ac837d4a1947a04fc23730b016aaa3107aa0cdc7395cb72fa241f8f7
|
|
BLAKE2b-256 checksum How to use checksums |
30a3fcffb090deb6f56eadb6439209abcafa8ad2593911a6d16f828cacbb869a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency logRelease files / refkv-0.1.0-cp312-abi3-macosx_11_0_arm64.whl
| Download URL | refkv-0.1.0-cp312-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 2.1 MB |
| Tags | CPython 3.12 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
ea206503e82fe6c9ae228b4896114dcd272e6fc2aeb55b684ac51b183440090e
|
|
BLAKE2b-256 checksum How to use checksums |
7551f9ab5cf97bd0455c8142014458f5b2f8c600197850ba38b471848229ba01
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency logRelease files / refkv-0.1.0-cp312-abi3-macosx_10_12_x86_64.whl
| Download URL | refkv-0.1.0-cp312-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 2.2 MB |
| Tags | CPython 3.12 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
cc236a3fee1df54154892e5d7e11a16884792e116eedaae665af4c521d068756
|
|
BLAKE2b-256 checksum How to use checksums |
8692aa1b0010e0faa20c822c58eb6e680b19ae2bd9a2f0749ef3dba6990a37d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency log
