miniswhid

No-frills Software Hash Identifier (SWHID) computation for files and directories.

Features

• Support for content (cnt) and directory (dir) SWHIDs
• Concurrent file hashing on multi-core systems
• Minimal dependencies — uses only Python standard library

Revision, release and snapshot SWHIDs are not supported.

Requirements

• Python 3.10 or higher

Installation

pip install miniswhid

Quick Start

Command Line

# Compute SWHID for a file
miniswhid README.md
# Output: swh:1:cnt:4c7fdf8...

# Compute SWHID for a directory  
miniswhid /path/to/directory
# Output: swh:1:dir:8b137891...

Python API

from miniswhid import compute_content_swhid, compute_directory_swhid

# File content SWHID
file_swhid = compute_content_swhid("README.md")
print(file_swhid)  # swh:1:cnt:4c7fdf8...

# Directory SWHID
dir_swhid = compute_directory_swhid("/path/to/directory")  
print(dir_swhid)   # swh:1:dir:8b137891...

Development

Running Tests

# Install development dependencies
uv sync

# Run test suite
uv run pytest

# Run with coverage
uv run pytest --cov=miniswhid

# Run linting and type checking
uvx ruff check
uvx ruff format
uvx mypy .

# Or run all checks via pre-commit
uv run pre-commit run --all-files

License

MIT - see LICENSE file.

Acknowledgements

This project's test suite uses reference SWHID values generated by the Software Heritage toolchain (swh identify) to ensure correctness and compatibility with the official implementation.

Changelog

0.1.1 (2026-03-14)

• Added Python 3.14 support
• Updated dependencies and tool versions
• Added tests for ThreadPoolExecutor error handling

0.1.0 (2025-08-13)

• Initial release with complete SWHID computation for files and directories
• Command-line interface (miniswhid command)
• Python API with compute_content_swhid() and compute_directory_swhid()
• Parallel processing for directory traversal
• Comprehensive test suite with 22+ tests using official Software Heritage reference values
• Type checking with mypy and strict type annotations
• Code formatting and linting with ruff
• Pre-commit hooks for code quality assurance
• Automated PyPI publishing via GitHub Actions
• TestPyPI workflow for release validation