Skip to main content

Rock-solid primitives for content-addressable hashing, chain fingerprinting, and config diffing

Project description

knurl

Rock-solid primitives for content-addressable hashing, chain fingerprinting, and config diffing.

Extracted from the SpiritEngine project.

Modules

  • canon - Canonical JSON serialization (RFC 8785 + mandatory Unicode NFC normalization). Deterministic, byte-identical across implementations and Python versions. Floats are rejected by default (pass accept_floats=True for non-hash use); integers keep their exact digits; NaN/Infinity, unassigned code points, and duplicate-after-NFC keys raise CanonError.
  • hash - Content-addressable hashing
  • chain - Merkle-like chain fingerprinting
  • diverge - Divergence detection for fingerprint chains
  • diff - JSON Patch (RFC 6902) diffs
  • yield_ - Yield data serialization

Installation

pip install knurl

# With diff support (requires jsonpatch)
pip install knurl[diff]

Usage

from knurl import canon, hash, chain, diverge

# Canonical serialization
canonical_bytes = canon.serialize({"b": 1, "a": 2})  # b'{"a":2,"b":1}'

# Content-addressable hashing
content_hash = hash.compute("hello world")        # 'sha256:...' (strings)
blob_hash = hash.compute_bytes(b"\x00\x01\x02")   # 'sha256:...' (raw bytes)
file_hash = hash.compute_file("video.mp4")        # 'sha256:...' (streamed, multi-GB safe)
tree_hash = hash.compute_tree("mirror/")          # 'sha256:...' (reproducible directory digest)

# Chain fingerprinting
fingerprints = chain.fingerprint([config1, config2, config3])

# Divergence detection
result = diverge.find(old_fingerprints, new_fingerprints)

Requirements

  • Python 3.10+
  • No dependencies (stdlib only)
  • Optional: jsonpatch for diff module

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

knurl-0.3.0.tar.gz (119.1 kB view details)

Uploaded Source

Built Distribution

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

knurl-0.3.0-py3-none-any.whl (29.8 kB view details)

Uploaded Python 3

File details

Details for the file knurl-0.3.0.tar.gz.

File metadata

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

File hashes

Hashes for knurl-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e5cea5f3baf845c339e7ba138bc676c805e8c2d00c9096d184987fd983d4f2d9
MD5 e0c235494ceb1ca2bc65e3c94a68f75a
BLAKE2b-256 279b00f940de4472a0e8e3fbbbefc752e0b8d9c220732fc1cb94fb490e937980

See more details on using hashes here.

Provenance

The following attestation bundles were made for knurl-0.3.0.tar.gz:

Publisher: publish.yml on spiritengine/knurl

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

File details

Details for the file knurl-0.3.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for knurl-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0b6b80040cc0fb5d527de16e2517ca600303d6d03ee47d6cd2e8a2f344a5a47
MD5 c9dc4d49d31353a26e84f4f32f24d100
BLAKE2b-256 0b648c60d15f0bb3f7395e39d6210b3941ff2162d7a78cfd617ca9be1fc4b086

See more details on using hashes here.

Provenance

The following attestation bundles were made for knurl-0.3.0-py3-none-any.whl:

Publisher: publish.yml on spiritengine/knurl

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