Metadata-Version: 2.4
Name: causalcore
Version: 0.1.0a1
Summary: Streaming SHA-256 file checksums
License-Expression: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# causalcore

Version 0.1.0a1 is a standalone SHA-256 file checksum utility. It hashes files
incrementally using the Python standard library. This alpha has no
causal-inference or machine learning functionality. Python 3.11 or later; no third-party dependencies.

```sh
python -m pip install causalcore==0.1.0a1
causalcore archive.zip
```

```python
from causalcore import sha256_file

digest = sha256_file("archive.zip")
print(digest)  # 64 lowercase hexadecimal characters
```

Files are opened in binary mode. `sha256_file` accepts a string or pathlib.Path,
returns the digest, and lets filesystem errors propagate to the caller. The
command prints a JSON object with `path` and `sha256`; filesystem errors go to
stderr with exit status 2. `python -m causalcore` is also supported.

A checksum verifies equality against a known digest; it does not establish who
created a file or whether a file is trustworthy.

The API may change during alpha development. Licensed under MIT; see LICENSE.
