hashprint-cli 1.0.0__tar.gz

hashprint_cli-1.0.0/.gitignore

@@ -0,0 +1,11 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+src/HashRadar/__pycache__
+
+# Virtual environments
+.venv

hashprint_cli-1.0.0/.python-version

@@ -0,0 +1 @@
+3.14

hashprint_cli-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Taha Qaisar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hashprint_cli-1.0.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.5
+Name: hashprint-cli
+Version: 1.0.0
+Summary: A forensic CLI tool for hash identification
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.14
+Requires-Dist: pyfiglet>=1.0.4
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich-argparse>=1.8.0
+Requires-Dist: rich>=15.0.0
+Description-Content-Type: text/markdown
+
+# HashPrint
+
+## What's this?
+
+***Note: this is a student project***
+
+Surely a random string like ***'b318c90ba09d05dfc9ff3991974eee68'*** can look scary.
+Be afraid no more, HashPrint got your back.
+
+## About HashPrint
+
+HashPrint is a forensic CLI tool that can identify which algorithm (like MD5, bcrypt, SHA256) produced the scary looking string, called a hash, like the above one.
+
+## Features of HashPrint
+
+1. **Hash Support:** HashPrint can identify 90+ hashes.
+2. **Export Options:** HashPrint allows you to export results in various formats, like JSON and YAML.
+3. **Multiple Hashes:** HashPrint can read multiple hashes from a text file. It can recursively scan a directory to locate text files that contain hashes. It can also accept multiple hashes from the command-line.
+4. **Coloured Output:** HashPrint outputs coloured results, making them easier to read.
+5. **Easy to use:** if you ever feel stuck, remember help is just a flag away.
+
+## Installation
+
+***Requires Python 3.14+***
+
+If installing with pip, then you must have Python 3.14 or higher installed on your system
+
+```console
+$ pip install hashprint
+```
+
+**OR with uv**
+
+uv installs the correct Python version if necessary
+
+**First setup a virtual environment:**
+
+```console
+$ uv venv
+```
+
+**Then install:**
+
+```console
+$ uv pip install hashprint
+```
+
+**Use without installing**
+
+***Requires uv***
+
+```console
+$ uv tool run hashprint
+```
+
+**OR**
+
+```console
+$ uvx hashprint
+```
+
+## How to use HashPrint?
+
+| Option | Purpose |
+|:------:|:-------------|
+*-h*, *--help* | shows the help message and exits. |
+*-f*, *--hash-file* | this option takes a path to a text file as an argument. With this option, HashPrint will read the file at the specified path for hashes. The file must contain one hash per line. |
+*-c*, *--hash* | this option takes a hash as an argument and identifies it. It should be between single quotes and without the 0x prefix. |
+*-x*, *--format* | this option lets you choose between the export formats. You can export the results in JSON, YAML and text formats. This option cannot work without the *-p*, *--path* option. |
+*-p*, *--path* | this option specifies the path of the export file. If a path to a pre-existing file is specified, it will be overwritten if it already contains content. If the file at the specified path does not exist, HashPrint will create it. |
+*-w*, *--walk* | this option recursively scans a directory at the specified path for text files, containing one hash per line. |
+*-v*, *--version* | this option displays the version number of HashPrint. |
+
+## Usage examples
+
+**For help**
+
+```console
+$ hashprint --help
+```
+
+**Display the version number**
+
+```console
+$ hashprint --version
+```
+
+**Identify a single hash**
+
+```console
+$ hashprint -c 'a9993e364706816aba3e25717850c26c9cd0d89d'
+```
+
+OR
+
+```console
+$ hashprint --hash 'a9993e364706816aba3e25717850c26c9cd0d89d'
+```
+
+**Identify multiple hashes**
+
+```console
+$ hashprint -c '0cc175b9c0f1b6a831c399e269772661' -c 'e8b7be43'
+```
+
+**Identify hashes from a file + export results to a file**
+
+```console
+$ hashprint -f path/to/txt/file/containing/hashes -x text -p path/of/export/file
+```
+
+The above command exports results in a human readable text format at a file of your choice. HashPrint will create the file if it does not exist.
+
+**Recursive Directory Scanner + exporting results to a file**
+
+```console
+$ hashprint -w path/to/directory -x format -p path/of/export/file
+```
+
+## LICENSE
+
+[MIT](./LICENSE)

hashprint_cli-1.0.0/README.md

@@ -0,0 +1,122 @@
+# HashPrint
+
+## What's this?
+
+***Note: this is a student project***
+
+Surely a random string like ***'b318c90ba09d05dfc9ff3991974eee68'*** can look scary.
+Be afraid no more, HashPrint got your back.
+
+## About HashPrint
+
+HashPrint is a forensic CLI tool that can identify which algorithm (like MD5, bcrypt, SHA256) produced the scary looking string, called a hash, like the above one.
+
+## Features of HashPrint
+
+1. **Hash Support:** HashPrint can identify 90+ hashes.
+2. **Export Options:** HashPrint allows you to export results in various formats, like JSON and YAML.
+3. **Multiple Hashes:** HashPrint can read multiple hashes from a text file. It can recursively scan a directory to locate text files that contain hashes. It can also accept multiple hashes from the command-line.
+4. **Coloured Output:** HashPrint outputs coloured results, making them easier to read.
+5. **Easy to use:** if you ever feel stuck, remember help is just a flag away.
+
+## Installation
+
+***Requires Python 3.14+***
+
+If installing with pip, then you must have Python 3.14 or higher installed on your system
+
+```console
+$ pip install hashprint
+```
+
+**OR with uv**
+
+uv installs the correct Python version if necessary
+
+**First setup a virtual environment:**
+
+```console
+$ uv venv
+```
+
+**Then install:**
+
+```console
+$ uv pip install hashprint
+```
+
+**Use without installing**
+
+***Requires uv***
+
+```console
+$ uv tool run hashprint
+```
+
+**OR**
+
+```console
+$ uvx hashprint
+```
+
+## How to use HashPrint?
+
+| Option | Purpose |
+|:------:|:-------------|
+*-h*, *--help* | shows the help message and exits. |
+*-f*, *--hash-file* | this option takes a path to a text file as an argument. With this option, HashPrint will read the file at the specified path for hashes. The file must contain one hash per line. |
+*-c*, *--hash* | this option takes a hash as an argument and identifies it. It should be between single quotes and without the 0x prefix. |
+*-x*, *--format* | this option lets you choose between the export formats. You can export the results in JSON, YAML and text formats. This option cannot work without the *-p*, *--path* option. |
+*-p*, *--path* | this option specifies the path of the export file. If a path to a pre-existing file is specified, it will be overwritten if it already contains content. If the file at the specified path does not exist, HashPrint will create it. |
+*-w*, *--walk* | this option recursively scans a directory at the specified path for text files, containing one hash per line. |
+*-v*, *--version* | this option displays the version number of HashPrint. |
+
+## Usage examples
+
+**For help**
+
+```console
+$ hashprint --help
+```
+
+**Display the version number**
+
+```console
+$ hashprint --version
+```
+
+**Identify a single hash**
+
+```console
+$ hashprint -c 'a9993e364706816aba3e25717850c26c9cd0d89d'
+```
+
+OR
+
+```console
+$ hashprint --hash 'a9993e364706816aba3e25717850c26c9cd0d89d'
+```
+
+**Identify multiple hashes**
+
+```console
+$ hashprint -c '0cc175b9c0f1b6a831c399e269772661' -c 'e8b7be43'
+```
+
+**Identify hashes from a file + export results to a file**
+
+```console
+$ hashprint -f path/to/txt/file/containing/hashes -x text -p path/of/export/file
+```
+
+The above command exports results in a human readable text format at a file of your choice. HashPrint will create the file if it does not exist.
+
+**Recursive Directory Scanner + exporting results to a file**
+
+```console
+$ hashprint -w path/to/directory -x format -p path/of/export/file
+```
+
+## LICENSE
+
+[MIT](./LICENSE)

hashprint_cli-1.0.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "hashprint-cli"
+version = "1.0.0"
+description = "A forensic CLI tool for hash identification"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "pyfiglet>=1.0.4",
+    "pyyaml>=6.0.3",
+    "rich>=15.0.0",
+    "rich-argparse>=1.8.0",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+
+[project.scripts]
+hashprint = "HashPrint.main:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/HashPrint"]

hashprint_cli-1.0.0/src/HashPrint/__init__.py

@@ -0,0 +1,7 @@
+# In the Name of God, the Most Compassionate, Most Merciful
+
+
+from importlib.metadata import version, metadata
+
+__version__ = version("HashPrint")
+__project_name__ = metadata("HashPrint").get("Name")

hashprint_cli-1.0.0/src/HashPrint/cli.py

@@ -0,0 +1,100 @@
+# In the Name of God, the Most Compassionate, Most Merciful
+
+
+import argparse
+import pyfiglet
+from rich_argparse import RichHelpFormatter
+from rich.console import Console
+from rich.theme import Theme
+import sys
+from HashPrint import __project_name__
+
+DISCLAIMER_MESSAGE = "Hash identification is based on pattern matching - therefore some hashes cannot be identified with certainty"
+POSSIBILITY_MESSAGE = "The string may not be a real hash"
+SUCCESS_MESSAGE = f"{__project_name__} ran successfully"
+
+
+class Parser(argparse.ArgumentParser):
+    def error(self, message):
+        console.print(f"[error]\nError: {message}[/error]")
+        console.print(f"[hint]{hint_line}[/hint]")
+        sys.exit()
+
+
+def print_banner():
+    banner = pyfiglet.figlet_format(__project_name__, font="slant")
+    console.print(f"[banner]{banner}[/banner]")
+
+
+theme = Theme(
+    {
+        "success": "#00A86B",  # Jade color
+        "information": "#00D084",  # Bright Jade color
+        "error": "bold #FF4A4A",  # Coral red color
+        "fail": "#EC5B38",  # Warm orange-red color
+        "hint": "#FF5FCF",  # Bright hot pink color
+        "banner": "#499A13",  # Vida Loca color
+        "description": "#24B1B1",  # Medium dark teal color
+        "usage": "#2F2FE4",  # Electric blue color
+        "disclaimer": "#B8860B",  # Dark goldenrod color
+        "warning": "#FFFF00",  # Yellow color
+    }
+)
+
+RichHelpFormatter.styles["argparse.args"] = "#03AED2"  # Sky blue color
+RichHelpFormatter.styles["argparse.groups"] = "#FF6D1F"  # Bright orange color
+RichHelpFormatter.styles["argparse.text"] = "#24B1B1"  # Medium dark teal color
+
+console = Console(highlight=False, theme=theme)
+
+
+description = "\nA forensic CLI tool for hash identification"
+hint_line = "\nRun with -h for usage information"
+program_name_cli = "hashprint"
+format_choices = ["text", "json", "yaml"]
+
+
+def cli_parser():
+    if len(sys.argv) == 1:
+        print_banner()
+        console.print(f"[description]{description}[/description]")
+        console.print(f"[hint]{hint_line}[/hint]")
+        sys.exit()
+
+    parser = Parser(
+        prog=program_name_cli,
+        description=description,
+        formatter_class=RichHelpFormatter,
+        color=False,
+    )
+    parser.add_argument(
+        "-f",
+        "--hash-file",
+        action="append",
+        help="path to a text (.txt) file containing one hash per line",
+    )
+    parser.add_argument(
+        "-c",
+        "--hash",
+        dest="candidate_hash",
+        action="append",
+        help="hash to identify between single quotes and without the 0x prefix",
+    )
+    parser.add_argument("-x", "--format", choices=format_choices, help="output format")
+    parser.add_argument(
+        "-p",
+        "--path",
+        metavar="PATH",
+        help="path of the output file - overwrites the file if it is not empty",
+    )
+    parser.add_argument(
+        "-w",
+        "--walk",
+        metavar="PATH",
+        help="recursively scans a directory for text (.txt) files - containing one hash per line",
+    )
+    parser.add_argument(
+        "-v", "--version", action="store_true", help="displays the version number"
+    )
+    args = parser.parse_args()
+    return args