Metadata-Version: 2.1
Name: hashio
Version: 0.5.2
Summary: Custom file and directory checksum tool
Author-email: Ryan Galloway <ryan@rsgalloway.com>
License: BSD 3-Clause License
Project-URL: Homepage, https://github.com/rsgalloway/hashio
Project-URL: Repository, https://github.com/rsgalloway/hashio
Project-URL: Issues, https://github.com/rsgalloway/hashio/issues
Project-URL: Documentation, https://github.com/rsgalloway/hashio
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lxml==5.4.0; python_version < "3.14"
Requires-Dist: lxml==6.0.4; python_version >= "3.14"
Requires-Dist: tqdm==4.67.1
Requires-Dist: xxhash==3.5.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"

# hashio

[![PyPI](https://img.shields.io/pypi/v/hashio.svg?color=blue)](https://pypi.org/project/hashio/)
[![CI](https://github.com/rsgalloway/hashio/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/rsgalloway/hashio/actions/workflows/tests.yml)
[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](LICENSE)

`hashio` is a checksum and verification tool for files and directory trees.

It can recursively hash content, collect filesystem metadata, verify manifests,
emit multiple output formats, and optionally persist results in a local SQLite
cache for snapshots and diffs.

## Highlights

- Multiple hash algorithms: `c4`, `crc32`, `md5`, `sha256`, `sha512`, `xxh64`
- Output formats: `json`, `txt`, and `mhl`
- Recursive hashing and manifest verification
- Configurable ignorable file patterns
- Metadata-only scans with the `null` algorithm
- Optional SQLite-backed cache and snapshot diffing

## Installation

```bash
pip install -U hashio
```

If your Python build does not include `sqlite3`, either rebuild Python with
SQLite support or install a pre-cache release:

```bash
pip install 'hashio<0.4.0'
```

## Quick Start

```bash
hashio <PATH> -o hash.json
hashio --verify hash.json
```

You can also run it directly with `uvx`:

```bash
uvx hashio <PATH>
```

## Documentation

Detailed documentation now lives under [docs/](docs/):

- [Overview](docs/index.md)
- [Getting Started](docs/getting-started.md)
- [Usage](docs/usage.md)
- [Configuration](docs/configuration.md)
- [Cache and Snapshots](docs/cache-and-snapshots.md)
- [Python API](docs/python-api.md)
