hashreport 1.2.0

Generate detailed file hash reports quickly and efficiently. Process large numbers of files with multiple filtering options.

hashreport

Overview

hashreport is a command-line tool that generates comprehensive hash reports for files within a directory. The reports can be output in CSV or JSON formats and include detailed information such as the file name, path, size, hash algorithm, hash value, and last modified date. Designed for speed and efficiency, hashreport can handle large volumes of files and offers filtering options to include or exclude files based on size, type, or name patterns.

Beta Release: This project is currently in beta. While feature-complete and well-tested, please report any issues you encounter.

Features

Core Features

• Multi-threaded processing for fast bulk hash generation
• Support for multiple hash algorithms (MD5, SHA-256, etc.)
• Recursive directory traversal
• Comprehensive file information in reports

Output Options

• CSV and JSON report formats
• Customizable output location
• Report viewer and comparison tool
• Email report delivery via SMTP

Filtering Capabilities

• Filter by file size (min/max)
• Filter by file type and name patterns
• Include/exclude file lists
• Processing limits and controls

Installation

There are two ways to install hashreport on your system. Choose the option that works best for you:

Install with Pip

You can install hashreport using pip from the Python Package Index (PyPI):

pip install hashreport

To upgrade, run hashreport upgrade (or pip install --upgrade hashreport). Prefer installing in a virtual environment.

Install from Source

Prerequisites

• Python 3 (tested with 3.10+)
• Git (optional)

1. Download the Repository

Clone the repository to your local machine using Git and navigate to the project directory:

git clone https://github.com/madebyjake/hashreport.git && cd hashreport

Alternatively, you can download the repository as a ZIP file and extract it to a folder on your machine.

2. Install Dependencies

First we'll install Poetry, a Python packaging and dependency management tool. There are a few ways to do this, but the recommended method is to use the installer script:

curl -sSL https://install.python-poetry.org | python3 -

Next, install the project dependencies using Poetry:

poetry install

3. Run the Application

You can now run the application using Poetry:

poetry run hashreport --version

License

This project is licensed under the Affero General Public License v3.0 - see the LICENSE file for details.

Issues and Feedback

Please report any issues or feedback on the GitHub Issues page.