# hashreport
[](https://www.python.org/)
[](https://python-poetry.org/)
[](https://www.mkdocs.org/)
[](https://www.gnu.org/licenses/agpl-3.0.en.html)<br>
[](https://github.com/madebyjake/hashreport/actions/workflows/codeql.yml)
[](https://github.com/madebyjake/hashreport/actions/workflows/test.yml)
[](https://github.com/madebyjake/hashreport/actions/workflows/security.yml)
## 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 a 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](https://pypi.org/project/hashreport/)):
```bash
pip install hashreport
```
### Install from Source
#### Prerequisites
- [Python 3](https://www.python.org/downloads/) (tested with 3.10+)
- [Git](https://git-scm.com/downloads) (optional)
#### 1. Download the Repository
Clone the repository to your local machine using Git and navigate to the project directory:
```bash
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:
```bash
curl -sSL https://install.python-poetry.org | python3 -
```
Next, install the project dependencies using Poetry:
```bash
poetry install
```
#### 3. Run the Application
You can now run the application using Poetry:
```bash
poetry run hashreport --version
```
## License
This project is licensed under the **Affero General Public License v3.0** - see the [LICENSE](LICENSE) file for details.
## Issues and Feedback
Please report any issues or feedback on the [GitHub Issues](https://github.com/madebyjake/hashreport/issues) page.
Raw data
{
"_id": null,
"home_page": null,
"name": "hashreport",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": null,
"keywords": "checksum, file, hash, hashing, integrity, report, security, utility, verification",
"author": "Jake Wells",
"author_email": "hashreport@fastmail.com",
"download_url": "https://files.pythonhosted.org/packages/f2/05/bfd11312a91044a23d22051c3e2432b05b1182d57c4e1c7d4f55c076ffa1/hashreport-1.0.0.tar.gz",
"platform": null,
"description": "# hashreport\n\n[](https://www.python.org/)\n[](https://python-poetry.org/)\n[](https://www.mkdocs.org/)\n[](https://www.gnu.org/licenses/agpl-3.0.en.html)<br>\n[](https://github.com/madebyjake/hashreport/actions/workflows/codeql.yml)\n[](https://github.com/madebyjake/hashreport/actions/workflows/test.yml)\n[](https://github.com/madebyjake/hashreport/actions/workflows/security.yml)\n\n## Overview\n\n**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.\n\n> **Beta Release**: This project is currently in beta. While feature-complete and well-tested, please report any issues you encounter.\n\n## Features\n\n### Core Features\n- Multi-threaded processing for fast bulk hash generation\n- Support for multiple hash algorithms (MD5, SHA-256, etc.)\n- Recursive directory traversal\n- Comprehensive file information in reports\n\n### Output Options\n- CSV and JSON report formats\n- Customizable output location\n- Report viewer and comparison tool\n- Email report delivery via SMTP\n\n### Filtering Capabilities\n- Filter by file size (min/max)\n- Filter by file type and name patterns\n- Include/exclude file lists\n- Processing limits and controls\n\n## Installation\n\nThere are a two ways to install **hashreport** on your system. Choose the option that works best for you:\n\n### Install with Pip\n\nYou can install **hashreport** using `pip` from the Python Package Index ([PyPI](https://pypi.org/project/hashreport/)):\n\n```bash\npip install hashreport\n```\n\n### Install from Source\n\n#### Prerequisites\n\n- [Python 3](https://www.python.org/downloads/) (tested with 3.10+)\n- [Git](https://git-scm.com/downloads) (optional)\n\n#### 1. Download the Repository\n\nClone the repository to your local machine using Git and navigate to the project directory:\n\n```bash\ngit clone https://github.com/madebyjake/hashreport.git && cd hashreport\n```\n\nAlternatively, you can download the repository as a ZIP file and extract it to a folder on your machine.\n\n#### 2. Install Dependencies\n\nFirst 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:\n\n```bash\ncurl -sSL https://install.python-poetry.org | python3 -\n```\n\nNext, install the project dependencies using Poetry:\n\n```bash\npoetry install\n```\n\n#### 3. Run the Application\n\nYou can now run the application using Poetry:\n\n```bash\npoetry run hashreport --version\n```\n\n## License\n\nThis project is licensed under the **Affero General Public License v3.0** - see the [LICENSE](LICENSE) file for details.\n\n## Issues and Feedback\n\nPlease report any issues or feedback on the [GitHub Issues](https://github.com/madebyjake/hashreport/issues) page.\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Generate detailed file hash reports quickly and efficiently. Process large numbers of files with multiple filtering options.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://madebyjake.github.io/hashreport/",
"Issues": "https://github.com/madebyjake/hashreport/issues",
"Repository": "https://github.com/madebyjake/hashreport"
},
"split_keywords": [
"checksum",
" file",
" hash",
" hashing",
" integrity",
" report",
" security",
" utility",
" verification"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7bd35c44bcc8a1ada96d248964044acc7a0050be6e3353477a0408cd839f040f",
"md5": "4c5e59e25fe922c65eb705b889c7a86c",
"sha256": "67b8a8c54b5fa51e84165a763551e88943340b251d26d46d4c75593fe1c9c42b"
},
"downloads": -1,
"filename": "hashreport-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c5e59e25fe922c65eb705b889c7a86c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 48694,
"upload_time": "2025-07-14T18:02:04",
"upload_time_iso_8601": "2025-07-14T18:02:04.842257Z",
"url": "https://files.pythonhosted.org/packages/7b/d3/5c44bcc8a1ada96d248964044acc7a0050be6e3353477a0408cd839f040f/hashreport-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f205bfd11312a91044a23d22051c3e2432b05b1182d57c4e1c7d4f55c076ffa1",
"md5": "2396ef78f79b2135bc8affc89050bcb9",
"sha256": "12fdbfa2c10c16d9e18cc5b23b8622587371d102ed75f1a6b6484896ee3157be"
},
"downloads": -1,
"filename": "hashreport-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2396ef78f79b2135bc8affc89050bcb9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.10",
"size": 41980,
"upload_time": "2025-07-14T18:02:06",
"upload_time_iso_8601": "2025-07-14T18:02:06.282614Z",
"url": "https://files.pythonhosted.org/packages/f2/05/bfd11312a91044a23d22051c3e2432b05b1182d57c4e1c7d4f55c076ffa1/hashreport-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-14 18:02:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "madebyjake",
"github_project": "hashreport",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hashreport"
}
JSON
