PyHashKit 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

pyhashkit/__init__.py

@@ -1,8 +1,11 @@
-from .hashing import hash_text, hash_file
-from .version import __version__
+from .hashing import hash_text, hash_file, algorithms
+from importlib.metadata import version
+
+__version__ = version("PyHashKit")
 
 __all__ = [
     "hash_text",
     "hash_file",
+    "algorithms",
     "__version__"
 ]

pyhashkit/cli.py

@@ -0,0 +1,142 @@
+import argparse
+
+from .hashing import hash_text, hash_file, algorithms
+from importlib.metadata import version
+
+
+__version__ = version("PyHashKit")
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="pyhashkit",
+        description="PyHashKit - Hash text and files using various algorithms",
+    )
+
+    parser.add_argument(
+        "-v",
+        "-V",
+        "--version",
+        action="store_true",
+        help="Show PyHashKit version",
+    )
+
+    subparsers = parser.add_subparsers(
+        dest="command",
+        help="Available commands",
+    )
+
+    text_parser = subparsers.add_parser(
+        "text",
+        help="Hash a text string",
+    )
+
+    text_parser.add_argument(
+        "text",
+        help="Text to hash",
+    )
+
+
+    text_parser.add_argument(
+        "-a",
+        "--algorithm",
+        default="sha256",
+        help="Hash algorithm (default: sha256)",
+    )
+
+    file_parser = subparsers.add_parser(
+        "file",
+        help="Hash a file",
+    )
+
+    file_parser.add_argument(
+        "path",
+        help="Path to file",
+    )
+
+    file_parser.add_argument(
+        "-a",
+        "--algorithm",
+        default="sha256",
+        help="Hash algorithm (default: sha256)",
+    )
+
+    subparsers.add_parser(
+        "commands",
+        help="List all available commands",
+    )
+
+    subparsers.add_parser(
+        "algorithms",
+        help="List all available hashing algorithms",
+    )
+
+    args = parser.parse_args()
+
+    if args.version:
+        print(f"PyHashKit v{__version__}")
+        return
+
+    try:
+        if args.command == "text":
+            print(hash_text(args.text, args.algorithm))
+        
+        elif args.command in ("algorithms"):
+            print("Available Algorithms:")
+
+            for alg in algorithms():
+                print(f"  - {alg}")
+
+        elif args.command == "file":
+            print(hash_file(args.path, args.algorithm))
+
+        elif args.command == "commands":
+            print("""
+Available Commands:
+
+  text         Hash a text string
+  file         Hash a file
+  commands     Show all commands
+
+Flags:
+
+  -v, -V,
+  --version    Show version information
+
+Options:
+
+  -a, --algorithm
+               Specify hashing algorithm
+               (default: sha256)
+
+Examples:
+
+  pyhashkit text "Hello World"
+
+  pyhashkit text "Hello World" -a md5
+
+  pyhashkit file example.txt
+
+  pyhashkit file example.txt -a sha512
+
+  pyhashkit -v
+""")
+
+        else:
+            parser.print_help()
+
+    except FileNotFoundError:
+        print(f"Error: File not found: {args.path}")
+
+    except PermissionError:
+        print(f"Error: Permission denied: {args.path}")
+
+    except ValueError as e:
+        print(f"Error: {e}")
+
+    except Exception as e:
+        print(f"Unexpected error: {e}")
+
+
+if __name__ == "__main__":
+    main()

pyhashkit/hashing.py

@@ -1,6 +1,15 @@
 import hashlib
 
+def algorithms():
+    return sorted(hashlib.algorithms_available)
+
+
 def hash_text(text: str, algorithm: str = "sha256") -> str:
+    if not isinstance(text, str):
+        raise TypeError(
+            "text must be a string"
+        )
+
     try:
         hash_obj = hashlib.new(algorithm)
     except ValueError:
@@ -12,8 +21,12 @@ def hash_text(text: str, algorithm: str = "sha256") -> str:
     return hash_obj.hexdigest()
 
 
-
 def hash_file(file_path: str, algorithm: str = "sha256") -> str:
+    if not isinstance(file_path, str):
+        raise TypeError(
+            "file_path must be a string"
+        )
+
     try:
         hash_obj = hashlib.new(algorithm)
     except ValueError:
@@ -21,8 +34,27 @@ def hash_file(file_path: str, algorithm: str = "sha256") -> str:
             f"Unsupported algorithm: {algorithm}"
         )
 
-    with open(file_path, "rb") as f:
-        for chunk in iter(lambda: f.read(8192), b""):
-            hash_obj.update(chunk)
+    try:
+        with open(file_path, "rb") as f:
+            for chunk in iter(
+                lambda: f.read(8192),
+                b""
+            ):
+                hash_obj.update(chunk)
+
+    except FileNotFoundError:
+        raise FileNotFoundError(
+            f"File not found: {file_path}"
+        )
+
+    except PermissionError:
+        raise PermissionError(
+            f"Permission denied: {file_path}"
+        )
+
+    except OSError as e:
+        raise OSError(
+            f"Failed to read file: {e}"
+        )
 
     return hash_obj.hexdigest()

{pyhashkit-0.1.0.dist-info → pyhashkit-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyHashKit
-Version: 0.1.0
+Version: 0.2.0
 Summary: A lightweight Python library for hashing text and files using multiple cryptographic algorithms.
 Home-page: https://github.com/Fmasterpro27/PyHashKit
 Author: fmasterpro27
@@ -30,7 +30,7 @@ Dynamic: requires-python
 
 # PyHashKit
 
-> A lightweight Python library for hashing text and files using multiple cryptographic algorithms.
+> A lightweight Python library and CLI for hashing text and files using multiple cryptographic algorithms.
 
 [![PyPI version](https://img.shields.io/pypi/v/pyhashkit.svg)](https://pypi.org/project/pyhashkit/)
 [![Python versions](https://img.shields.io/pypi/pyversions/pyhashkit.svg)](https://pypi.org/project/pyhashkit/)
@@ -42,6 +42,7 @@ Dynamic: requires-python
 
 - 🔐 Hash text strings
 - 📄 Hash files of any size
+- 💻 Built-in CLI support
 - ⚡ Supports multiple algorithms
 - 📦 Zero dependencies
 - 🐍 Python 3.8+
@@ -49,9 +50,17 @@ Dynamic: requires-python
 
 ---
 
+## Why PyHashKit?
+
+PyHashKit provides a simple and beginner-friendly interface for Python's built-in hashing functionality.
+
+Instead of manually working with `hashlib`, you can hash text and files with a single function call or directly from the command line.
+
+---
+
 ## Supported Algorithms
 
-PyHashKit supports any algorithm available through Python's built-in `hashlib`.
+PyHashKit supports most algorithms available through Python's built-in `hashlib`.
 
 Common examples:
 
@@ -68,6 +77,15 @@ Common examples:
 - BLAKE2b
 - BLAKE2s
 
+### Not Supported
+
+The following algorithms are currently not supported:
+
+- SHAKE-128 (`shake_128`)
+- SHAKE-256 (`shake_256`)
+
+These algorithms require a custom digest length and are intentionally excluded to keep the API simple and consistent.
+
 ---
 
 ## Installation
@@ -89,9 +107,76 @@ print(hash_file("example.txt"))
 
 ---
 
-## Python API
+# Command Line Interface (CLI)
+
+PyHashKit includes a built-in command-line interface for hashing text and files directly from your terminal.
+
+## Available Commands
+
+```text
+text         Hash a text string
+file         Hash a file
+commands     Show all commands
+```
+
+## Flags
+
+```text
+-v, -V, --version
+             Show version information
+```
+
+## Options
 
-### Hash Text
+```text
+-a, --algorithm
+             Specify hashing algorithm
+             (default: sha256)
+```
+
+## Examples
+
+Hash text:
+
+```bash
+pyhashkit text "Hello World"
+```
+
+Hash text using MD5:
+
+```bash
+pyhashkit text "Hello World" -a md5
+```
+
+Hash a file:
+
+```bash
+pyhashkit file example.txt
+```
+
+Hash a file using SHA-512:
+
+```bash
+pyhashkit file example.txt -a sha512
+```
+
+Show version information:
+
+```bash
+pyhashkit -v
+```
+
+Show all available commands:
+
+```bash
+pyhashkit commands
+```
+
+---
+
+# Python API
+
+## Hash Text
 
 ```python
 from pyhashkit import hash_text
@@ -101,7 +186,7 @@ result = hash_text("Hello World")
 print(result)
 ```
 
-### Hash Text Using MD5
+## Hash Text Using MD5
 
 ```python
 from pyhashkit import hash_text
@@ -114,7 +199,7 @@ result = hash_text(
 print(result)
 ```
 
-### Hash File
+## Hash File
 
 ```python
 from pyhashkit import hash_file
@@ -124,7 +209,7 @@ result = hash_file("example.txt")
 print(result)
 ```
 
-### Hash File Using SHA-512
+## Hash File Using SHA-512
 
 ```python
 from pyhashkit import hash_file
@@ -139,11 +224,43 @@ print(result)
 
 ---
 
+## Version Information
+
+```python
+from pyhashkit import __version__
+
+print(__version__)
+```
+
+---
+
+## Available Exports
+
+```python
+from pyhashkit import (
+    hash_text,
+    hash_file,
+    algorithms,
+    __version__
+)
+```
+
+### algorithms
+
+Returns a list of supported hashing algorithms available on the current Python installation.
+
+```python
+from pyhashkit import algorithms
+
+print(algorithms())
+```
+
+---
+
 ## Example Output
 
 ```text
-a591a6d40bf420404a011733cfb7b190
-d62c65bf0bcda32b57b277d9ad9f146e
+a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e
 ```
 
 ---
@@ -155,6 +272,7 @@ PyHashKit/
 ├── pyhashkit/
 │   ├── __init__.py
 │   ├── hashing.py
+│   ├── cli.py
 │   └── version.py
 ├── tests/
 │   └── test_hashing.py
@@ -170,12 +288,21 @@ PyHashKit/
 Contributions, bug reports, and feature requests are welcome.
 
 1. Fork the repository
-2. Create a branch
+2. Create a new branch
 3. Make your changes
 4. Submit a pull request
 
 ---
 
+## Author
+
+Developed by **JackMa**
+
+GitHub:
+https://github.com/Fmasterpro27
+
+---
+
 ## Links
 
 Homepage:

pyhashkit-0.2.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+pyhashkit/__init__.py,sha256=71gwuHE-9hbMSMvgA58m6Ljb6NN1pJ7ildSCVq9YMMo,223
+pyhashkit/cli.py,sha256=4G-9qkvjmSfBT9UjjvlSWr3HZRsH-wbsXysMUN8TZ8k,2942
+pyhashkit/hashing.py,sha256=BfILbuLyEOMt4VM6aHDZNWsGmMiFhczeUXdspWn-fa0,1445
+pyhashkit/version.py,sha256=Pru0BlFBASFCFo7McHdohtKkUtgMPDwbGfyUZlE2_Vw,21
+pyhashkit-0.2.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyhashkit-0.2.0.dist-info/METADATA,sha256=veKhERdJNI6vOtcRdDL2PvnCY5FMJ31A4HwN1Egb2yc,5862
+pyhashkit-0.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pyhashkit-0.2.0.dist-info/entry_points.txt,sha256=J0l-83OwffVqEfIC6Zq6CjBTarX_S0eqkUVaPb9ASv4,49
+pyhashkit-0.2.0.dist-info/top_level.txt,sha256=i4mBVLg3ASdKUsNh8G4uPlNWRI1_a1rGhpQVPJ1kIac,10
+pyhashkit-0.2.0.dist-info/RECORD,,

pyhashkit-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyhashkit = pyhashkit.cli:main

pyhashkit-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-pyhashkit/__init__.py,sha256=ln2HpPAwaRwaD34N6JOOSFBEzmR7XqmJNMk1bWJ3DkQ,148
-pyhashkit/hashing.py,sha256=ogXXqXtCJ7_FT7L8EfaCX50IipoOffTAC4EsnXErPy4,725
-pyhashkit/version.py,sha256=Pru0BlFBASFCFo7McHdohtKkUtgMPDwbGfyUZlE2_Vw,21
-pyhashkit-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyhashkit-0.1.0.dist-info/METADATA,sha256=MzpM310DedDVRFK1ARxZCxHLyS4j7Sn_Yc4yXKD2KTI,3829
-pyhashkit-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-pyhashkit-0.1.0.dist-info/top_level.txt,sha256=i4mBVLg3ASdKUsNh8G4uPlNWRI1_a1rGhpQVPJ1kIac,10
-pyhashkit-0.1.0.dist-info/RECORD,,