Skip to main content

HTML-aware compression for document corpora — solid-archive ratios with random access

Project description

Storetle

HTML-aware compression for document corpora — solid-archive ratios with random access.

Storetle stores large collections of HTML (web crawls, academic corpora, training datasets) in a format that is ~46% smaller than the per-record gzip WARC files the web-archiving world ships today, while still letting you pull any single document out of a multi-gigabyte archive without decompressing the rest — locally, or straight off object storage.

pip: storetle (Python, read/write)  ·  rust/: storetle-rs (Rust, read)  ·  web/: read .storetle in the browser

The honest benchmark

Two different questions, two tables. Corpus: 10 real pages (Wikipedia, arXiv abstracts, PLOS articles), 1.75 MB raw HTML, measured June 2026. Reproduce with storetle bench <folder>.

1. Among formats with random access (you can extract one doc without decompressing everything before it — this is how WARC is actually deployed):

method bytes vs deployed standard
per-record gzip -9 (standard WARC) 373,626
per-record zstd -19 325,807 −12.8%
per-record zstd -19 + trained dict 274,226 −26.6%
storetle 200,598 −46.3%

2. Against solid archives (maximum compression, no random access):

method bytes
tar + gzip -9 370,307
tar + zstd -19 220,512
tar + zstd -22 --long 220,422
tar + zstd -22 + trained dict 204,386
storetle (keeps random access) 200,598

Storetle matches solid zstd-22 while remaining randomly accessible. The margin comes from three things: HTML-aware encoding (tags/attributes become 1-byte IDs from a shared vocabulary, structure and text compressed as separate streams), a 1 MB dictionary trained on the binary encoding, and 256-document chunks that capture cross-page template redundancy.

On larger corpora measured against gzip WARC: 28.4% smaller on 3,000 live Common Crawl docs (348.6 MB), 27–82% on same-domain collections (191 pages, 20 domains) where template sharing is strongest. Round-trip verified on all of the above. Stream it yourself: python3 bench_cc.py --docs 3000.

Install

brew install zstd        # macOS   (Ubuntu: apt install libzstd-dev)
pip install storetle

No Python dependencies — stdlib plus system libzstd via ctypes (brotli fallback if zstd is missing). lxml is optional but strongly recommended for encoding speed.

CLI

storetle pack      my_crawl/ archive.storetle     # folder of .html → archive
storetle unpack    archive.storetle out/          # archive → .html files
storetle info      archive.storetle               # stats
storetle get       archive.storetle 42            # one doc to stdout, O(1)
storetle bench     my_crawl/                      # benchmark on YOUR data
storetle from-warc CC-MAIN.warc.gz archive.storetle
storetle to-warc   archive.storetle out.warc.gz
storetle train     my_corpus/ --output my.bin     # domain-specific dictionary

Hosted corpora — free

Simple English Wikipedia, complete — 267,503 articles, 10.06 GB of HTML in 843 MB, snapshot 2025-03-20, CC-BY-SA-4.0. Six self-contained shards with JSONL metadata indexes (title ↔ doc index) and a SHA-256 manifest:

https://pub-0a9a18b1320f46f794f8374a71aa608b.r2.dev/simplewiki/manifest.json

Pull one article out of a 100+ MB shard, by index, in ~2 seconds:

storetle get https://pub-0a9a18b1320f46f794f8374a71aa608b.r2.dev/simplewiki/simplewiki-20250320-0005.storetle 11244            # Albert Einstein, full HTML
storetle get https://pub-0a9a18b1320f46f794f8374a71aa608b.r2.dev/simplewiki/simplewiki-20250320-0005.storetle 11244 --text     # …as clean plain text

Find a title's index by grepping the shard's .index.jsonl. More corpora (arXiv, PubMed Central OA) coming.

Plain text extraction (v0.2.2)

--text on get/unpack (and get_text()/iter_text() in the API) extracts tag-stripped clean text without re-parsing HTML — the encoding already separates structure from content, so text extraction is a walk over the structure opcodes that keeps text nodes, drops script/style bodies, and emits newlines at block boundaries. A 383 KB Wikipedia article becomes 39 KB of readable text.

Remote archives (v0.2.1)

get, info, and unpack accept URLs. Opening an archive costs a few KB of Range requests; fetching a document downloads only its ~2MB chunk — no server-side code, works against any Range-capable host (R2, S3, GitHub Pages, nginx):

storetle info https://adventurelands.github.io/storetle/sample.storetle
storetle get  https://adventurelands.github.io/storetle/sample.storetle 4
from storetle import RemoteReader
with RemoteReader('https://host/corpus.storetle') as r:
    html = r[42]          # one ~2MB range request

Python API

import storetle

with storetle.StreamWriter('archive.storetle', workers=8) as w:
    for html in crawl:
        w.append(html)

with storetle.StreamReader('archive.storetle') as r:
    print(r.doc_count)
    doc   = r[42]          # random access: decompresses one ~2MB chunk
    batch = r[100:200]
    for doc in r:          # sequential
        ...

Rust reader

A read-only Rust implementation lives in rust/ — library plus a storetle-rs CLI (ls / get / unpack), differentially tested byte-for-byte against the Python decoder.

In the browser

web/ has a zero-dependency demo page: the Rust reader compiled to WebAssembly. Drop a .storetle file onto the page and browse its documents.

How it works

  1. Parse — HTML is tokenized to a node stream (lxml fast path, pure-Python fallback).
  2. Encode — tags and attribute names become 1-byte IDs from a fixed vocabulary (130 tags, 163 attributes, 1,394 shared strings). class="flex items-center gap-4" is split into per-token vocabulary lookups. Structure and text go to separate streams.
  3. Chunk — up to 256 docs / 2 MiB are concatenated, preserving cross-document redundancy.
  4. Compress — zstd-22 with a 1 MB dictionary trained on the binary encoding (ships with the codec).
  5. Index — a footer index maps documents to chunks, so readers seek instead of scanning. Works over HTTP range requests against plain object storage.

Full byte-level spec: FORMAT.md.

Limitations — read these

  • Structural, not byte-exact. Reconstructed HTML preserves every tag, attribute, text node, comment, and script/style body, but is re-serialized (indentation and inter-tag whitespace differ). Fine for corpora and ML pipelines; wrong for byte-exact archival — if you need forensic fidelity, use WARC.
  • HTML only. from-warc keeps HTML response records and skips everything else. A raw passthrough mode for JSON/text is on the roadmap.
  • Encoding speed ~3.5 MB/s per core (Python). Parallel via workers=N. Decoding is zstd-bound and fast. A native encoder is on the roadmap.
  • Alpha. Format version 2. Validated on 150k+ Common Crawl documents, but expect rough edges.

License

MIT © 2026 Davis Brief

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

storetle-0.2.2.tar.gz (443.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

storetle-0.2.2-py3-none-any.whl (446.1 kB view details)

Uploaded Python 3

File details

Details for the file storetle-0.2.2.tar.gz.

File metadata

  • Download URL: storetle-0.2.2.tar.gz
  • Upload date:
  • Size: 443.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for storetle-0.2.2.tar.gz
Algorithm Hash digest
SHA256 0d56b68d0db7ed2410080f7824e602fc3cd32c7848f620e39d2b27b0e4c87579
MD5 8190e78f5fa9bbe0f944e6f6b29b3cce
BLAKE2b-256 4c0b7d662e559fd6d3771fd6c276812fb1e45edd48f53996af0ed0c5d5215d1a

See more details on using hashes here.

Provenance

The following attestation bundles were made for storetle-0.2.2.tar.gz:

Publisher: publish.yml on adventurelands/storetle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file storetle-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: storetle-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 446.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for storetle-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a73a028ed3eacf0000f62e4af9670c2cfbaa977d578026e25e31cd474a4ac32c
MD5 7f7b752f8415f7ac22d776bc995d9adc
BLAKE2b-256 c0a117ab6393be388fac392baeff6cbd0e58ca14807008178a189dd681f67288

See more details on using hashes here.

Provenance

The following attestation bundles were made for storetle-0.2.2-py3-none-any.whl:

Publisher: publish.yml on adventurelands/storetle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page