paqPy

Hash file or directory recursively.

Python bindings to the Rust paq library.

Powered by blake3 cryptographic hashing algorithm.

Performance

The Go programming language repository was used as a test data source (157 MB / 14,490 files).

See paq benchmarks documentation for more details.

Installation

Install From PyPI

pip install paqpy

Install From Repository (Unstable)

Not recommended due to instability of main branch in-between tagged releases.

1. Clone this repository.
2. Run pip install maturin to install maturin.
3. Run maturin develop --release from repository root.

Usage

import paqpy

from pathlib import Path

source = Path("/path/to/source")
ignore_hidden = True # .dir or .file
source_hash = paqpy.hash_source(source, ignore_hidden)

print(source_hash)

hash_source returns a hexadecimal hash string. File system failures raise the corresponding Python OSError subclass, such as FileNotFoundError or PermissionError. Invalid UTF-8 paths raise UnicodeError, invalid source relationships raise ValueError, and other hashing failures raise paqpy.PaqError.

Visit the paq homepage for more details.

License

MIT