hashcheck 0.1.3__tar.gz

hashcheck-0.1.3/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python 3.13
+        shell: bash
+        run: uv python install 3.13
+
+      - run: uv sync --frozen
+      - run: uv run pytest
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: test
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for trusted publishing
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - run: uv build
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

hashcheck-0.1.3/.gitignore

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

hashcheck-0.1.3/.python-version

@@ -0,0 +1 @@
+3.13

hashcheck-0.1.3/CLAUDE.md

@@ -0,0 +1,22 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+`hash-checker` is a Python 3.13 CLI tool (currently in early development). Entry point is `main.py:main()`.
+
+## Commands
+
+This project uses `uv` for dependency and environment management.
+
+```bash
+# Run the project
+uv run python main.py
+
+# Add a dependency
+uv add <package>
+
+# Install dependencies
+uv sync
+```

hashcheck-0.1.3/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: hashcheck
+Version: 0.1.3
+Summary: Simple file hash checker
+Requires-Python: >=3.13
+Requires-Dist: cloup>=3.0.8
+Description-Content-Type: text/markdown
+
+# hash-checker
+
+A CLI tool for computing and comparing MD5 hashchecks.
+
+## Installation
+
+```bash
+uv tool install .
+```
+
+## Usage
+
+### Get the MD5 hash of a file
+
+```bash
+hashcheck <filepath>
+```
+
+```
+$ hashcheck photo.jpg
+d8e8fca2dc0f896fd7cb4cb0031ba249  photo.jpg
+```
+
+### Compare files
+
+Pass two or more files — hashes are always printed, and the exit code indicates whether they match.
+
+```bash
+hashcheck <file1> <file2> [file3 ...]
+```
+
+```
+$ hashcheck file_a.zip file_b.zip
+d8e8fca2dc0f896fd7cb4cb0031ba249  file_a.zip
+d8e8fca2dc0f896fd7cb4cb0031ba249  file_b.zip
+All files match.
+
+$ hashcheck original.zip modified.zip
+d8e8fca2dc0f896fd7cb4cb0031ba249  original.zip
+aabbcc112233445566778899aabbcc11  modified.zip
+Files do not match.
+```
+
+## Releasing
+
+Releases are published to PyPI automatically by the CI workflow when a version tag is pushed.
+
+**1. Bump the version in `pyproject.toml`**
+
+```toml
+[project]
+version = "0.2.0"
+```
+
+**2. Commit the version bump**
+
+```bash
+git add pyproject.toml
+git commit -m "chore: bump version to 0.2.0"
+```
+
+**3. Tag and push**
+
+```bash
+git tag v0.2.0
+git push origin main --tags
+```
+
+The `publish` job in CI will build the package and upload it to PyPI once all tests pass.
+
+> **First-time setup:** PyPI Trusted Publishing must be configured before the first release.
+> Go to your PyPI project → *Manage* → *Publishing* and add a trusted publisher:
+> - Publisher: GitHub
+> - Repository: `<owner>/hash-checker`
+> - Workflow: `ci.yml`
+> - Environment: `pypi`

hashcheck-0.1.3/README.md

@@ -0,0 +1,76 @@
+# hash-checker
+
+A CLI tool for computing and comparing MD5 hashchecks.
+
+## Installation
+
+```bash
+uv tool install .
+```
+
+## Usage
+
+### Get the MD5 hash of a file
+
+```bash
+hashcheck <filepath>
+```
+
+```
+$ hashcheck photo.jpg
+d8e8fca2dc0f896fd7cb4cb0031ba249  photo.jpg
+```
+
+### Compare files
+
+Pass two or more files — hashes are always printed, and the exit code indicates whether they match.
+
+```bash
+hashcheck <file1> <file2> [file3 ...]
+```
+
+```
+$ hashcheck file_a.zip file_b.zip
+d8e8fca2dc0f896fd7cb4cb0031ba249  file_a.zip
+d8e8fca2dc0f896fd7cb4cb0031ba249  file_b.zip
+All files match.
+
+$ hashcheck original.zip modified.zip
+d8e8fca2dc0f896fd7cb4cb0031ba249  original.zip
+aabbcc112233445566778899aabbcc11  modified.zip
+Files do not match.
+```
+
+## Releasing
+
+Releases are published to PyPI automatically by the CI workflow when a version tag is pushed.
+
+**1. Bump the version in `pyproject.toml`**
+
+```toml
+[project]
+version = "0.2.0"
+```
+
+**2. Commit the version bump**
+
+```bash
+git add pyproject.toml
+git commit -m "chore: bump version to 0.2.0"
+```
+
+**3. Tag and push**
+
+```bash
+git tag v0.2.0
+git push origin main --tags
+```
+
+The `publish` job in CI will build the package and upload it to PyPI once all tests pass.
+
+> **First-time setup:** PyPI Trusted Publishing must be configured before the first release.
+> Go to your PyPI project → *Manage* → *Publishing* and add a trusted publisher:
+> - Publisher: GitHub
+> - Repository: `<owner>/hash-checker`
+> - Workflow: `ci.yml`
+> - Environment: `pypi`

hashcheck-0.1.3/hashcheck/main.py

@@ -0,0 +1,38 @@
+import hashlib
+import sys
+
+import cloup
+
+
+def md5_hash(filepath: str) -> str:
+    md5 = hashlib.md5()
+    with open(filepath, "rb") as f:
+        for chunk in iter(lambda: f.read(8192), b""):
+            md5.update(chunk)
+    return md5.hexdigest()
+
+
+@cloup.command()
+@cloup.argument("files", nargs=-1, required=True)
+def main(files: tuple[str, ...]) -> None:
+    """Get the MD5 hash of one or more files. Compares hashes when multiple files are given."""
+    hashes: dict[str, str] = {}
+    for filepath in files:
+        try:
+            digest = md5_hash(filepath)
+            hashes[filepath] = digest
+            print(f"{digest}  {filepath}")
+        except FileNotFoundError:
+            print(f"Error: file not found: {filepath}", file=sys.stderr)
+            sys.exit(1)
+        except PermissionError:
+            print(f"Error: permission denied: {filepath}", file=sys.stderr)
+            sys.exit(1)
+
+    if len(files) > 1:
+        unique_hashes = set(hashes.values())
+        if len(unique_hashes) == 1:
+            print("All files match.")
+        else:
+            print("Files do not match.", file=sys.stderr)
+            sys.exit(1)

hashcheck-0.1.3/main.py

@@ -0,0 +1,4 @@
+from hash_checker import main
+
+if __name__ == "__main__":
+    main()

hashcheck-0.1.3/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "hashcheck"
+version = "0.1.3"
+description = "Simple file hash checker"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "cloup>=3.0.8",
+]
+
+[project.scripts]
+hashcheck = "hashcheck.main:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

hashcheck-0.1.3/tests/test_hashcheck.py

@@ -0,0 +1,113 @@
+import hashlib
+
+import pytest
+from click.testing import CliRunner
+
+from hashcheck.main import main, md5_hash
+
+
+@pytest.fixture
+def runner():
+    return CliRunner()
+
+
+# --- md5_hash ---
+
+def test_md5_hash_returns_correct_digest(tmp_path):
+    f = tmp_path / "file.txt"
+    f.write_bytes(b"hello world")
+    expected = hashlib.md5(b"hello world").hexdigest()
+    assert md5_hash(str(f)) == expected
+
+
+def test_md5_hash_empty_file(tmp_path):
+    f = tmp_path / "empty.txt"
+    f.write_bytes(b"")
+    expected = hashlib.md5(b"").hexdigest()
+    assert md5_hash(str(f)) == expected
+
+
+def test_md5_hash_raises_on_missing_file(tmp_path):
+    with pytest.raises(FileNotFoundError):
+        md5_hash(str(tmp_path / "nonexistent.txt"))
+
+
+# --- hashcheck <filepath> ---
+
+def test_main_prints_hash(runner, tmp_path):
+    f = tmp_path / "file.txt"
+    f.write_bytes(b"hello world")
+    expected = hashlib.md5(b"hello world").hexdigest()
+
+    result = runner.invoke(main, [str(f)])
+
+    assert result.exit_code == 0
+    assert f"{expected}  {str(f)}" in result.output
+
+
+def test_main_no_args_shows_error(runner):
+    result = runner.invoke(main, [])
+    assert result.exit_code != 0
+
+
+def test_main_file_not_found(runner, tmp_path):
+    result = runner.invoke(main, [str(tmp_path / "missing.txt")])
+    assert result.exit_code == 1
+    assert "file not found" in result.output
+
+
+# --- hashcheck <file1> <file2> ... ---
+
+def test_compare_matching_files(runner, tmp_path):
+    f1 = tmp_path / "a.txt"
+    f2 = tmp_path / "b.txt"
+    f1.write_bytes(b"same content")
+    f2.write_bytes(b"same content")
+
+    result = runner.invoke(main, [str(f1), str(f2)])
+
+    assert result.exit_code == 0
+    assert "All files match." in result.output
+    digest = hashlib.md5(b"same content").hexdigest()
+    assert f"{digest}  {str(f1)}" in result.output
+    assert f"{digest}  {str(f2)}" in result.output
+
+
+def test_compare_different_files(runner, tmp_path):
+    f1 = tmp_path / "a.txt"
+    f2 = tmp_path / "b.txt"
+    f1.write_bytes(b"content a")
+    f2.write_bytes(b"content b")
+
+    result = runner.invoke(main, [str(f1), str(f2)])
+
+    assert result.exit_code == 1
+    assert "do not match" in result.output
+    assert hashlib.md5(b"content a").hexdigest() in result.output
+    assert hashlib.md5(b"content b").hexdigest() in result.output
+
+
+def test_compare_multiple_files_all_match(runner, tmp_path):
+    files = []
+    for name in ["a.txt", "b.txt", "c.txt"]:
+        f = tmp_path / name
+        f.write_bytes(b"identical")
+        files.append(str(f))
+
+    result = runner.invoke(main, files)
+
+    assert result.exit_code == 0
+    assert "All files match." in result.output
+    digest = hashlib.md5(b"identical").hexdigest()
+    for filepath in files:
+        assert f"{digest}  {filepath}" in result.output
+
+
+def test_compare_file_not_found(runner, tmp_path):
+    f = tmp_path / "exists.txt"
+    f.write_bytes(b"data")
+
+    result = runner.invoke(main, [str(f), str(tmp_path / "missing.txt")])
+
+    assert result.exit_code == 1
+    assert "file not found" in result.output

hashcheck-0.1.3/uv.lock

@@ -0,0 +1,107 @@
+version = 1
+revision = 3
+requires-python = ">=3.13"
+
+[[package]]
+name = "click"
+version = "8.3.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "colorama", marker = "sys_platform == 'win32'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/3d/fa/656b739db8587d7b5dfa22e22ed02566950fbfbcdc20311993483657a5c0/click-8.3.1.tar.gz", hash = "sha256:12ff4785d337a1bb490bb7e9c2b1ee5da3112e94a8622f26a6c77f5d2fc6842a", size = 295065, upload-time = "2025-11-15T20:45:42.706Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/98/78/01c019cdb5d6498122777c1a43056ebb3ebfeef2076d9d026bfe15583b2b/click-8.3.1-py3-none-any.whl", hash = "sha256:981153a64e25f12d547d3426c367a4857371575ee7ad18df2a6183ab0545b2a6", size = 108274, upload-time = "2025-11-15T20:45:41.139Z" },
+]
+
+[[package]]
+name = "cloup"
+version = "3.0.8"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "click" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/46/cf/09a31f0f51b5c8ef2343baf37c35a5feb4f6dfdcbd0592a014baf837f2e4/cloup-3.0.8.tar.gz", hash = "sha256:f91c080a725196ddf74feabd6250266f466e97fc16dfe21a762cf6bc6beb3ecb", size = 229657, upload-time = "2025-08-05T02:25:02.83Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/45/0a/494a923f90cd97cdf4fb989cfd06ac0c6745f6dfb8adcef1b7f99d3c7834/cloup-3.0.8-py2.py3-none-any.whl", hash = "sha256:6fe9474dc44fa06f8870e9c797f005de1e3ef891ddc1a9612d9b58598a038323", size = 54647, upload-time = "2025-08-05T02:25:01.536Z" },
+]
+
+[[package]]
+name = "colorama"
+version = "0.4.6"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/d8/53/6f443c9a4a8358a93a6792e2acffb9d9d5cb0a5cfd8802644b7b1c9a02e4/colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", size = 27697, upload-time = "2022-10-25T02:36:22.414Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6", size = 25335, upload-time = "2022-10-25T02:36:20.889Z" },
+]
+
+[[package]]
+name = "hashcheck"
+version = "0.1.3"
+source = { editable = "." }
+dependencies = [
+    { name = "cloup" },
+]
+
+[package.dev-dependencies]
+dev = [
+    { name = "pytest" },
+]
+
+[package.metadata]
+requires-dist = [{ name = "cloup", specifier = ">=3.0.8" }]
+
+[package.metadata.requires-dev]
+dev = [{ name = "pytest", specifier = ">=9.0.2" }]
+
+[[package]]
+name = "iniconfig"
+version = "2.3.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/72/34/14ca021ce8e5dfedc35312d08ba8bf51fdd999c576889fc2c24cb97f4f10/iniconfig-2.3.0.tar.gz", hash = "sha256:c76315c77db068650d49c5b56314774a7804df16fee4402c1f19d6d15d8c4730", size = 20503, upload-time = "2025-10-18T21:55:43.219Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/cb/b1/3846dd7f199d53cb17f49cba7e651e9ce294d8497c8c150530ed11865bb8/iniconfig-2.3.0-py3-none-any.whl", hash = "sha256:f631c04d2c48c52b84d0d0549c99ff3859c98df65b3101406327ecc7d53fbf12", size = 7484, upload-time = "2025-10-18T21:55:41.639Z" },
+]
+
+[[package]]
+name = "packaging"
+version = "26.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/65/ee/299d360cdc32edc7d2cf530f3accf79c4fca01e96ffc950d8a52213bd8e4/packaging-26.0.tar.gz", hash = "sha256:00243ae351a257117b6a241061796684b084ed1c516a08c48a3f7e147a9d80b4", size = 143416, upload-time = "2026-01-21T20:50:39.064Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/b7/b9/c538f279a4e237a006a2c98387d081e9eb060d203d8ed34467cc0f0b9b53/packaging-26.0-py3-none-any.whl", hash = "sha256:b36f1fef9334a5588b4166f8bcd26a14e521f2b55e6b9de3aaa80d3ff7a37529", size = 74366, upload-time = "2026-01-21T20:50:37.788Z" },
+]
+
+[[package]]
+name = "pluggy"
+version = "1.6.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/f9/e2/3e91f31a7d2b083fe6ef3fa267035b518369d9511ffab804f839851d2779/pluggy-1.6.0.tar.gz", hash = "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3", size = 69412, upload-time = "2025-05-15T12:30:07.975Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/54/20/4d324d65cc6d9205fabedc306948156824eb9f0ee1633355a8f7ec5c66bf/pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746", size = 20538, upload-time = "2025-05-15T12:30:06.134Z" },
+]
+
+[[package]]
+name = "pygments"
+version = "2.19.2"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/b0/77/a5b8c569bf593b0140bde72ea885a803b82086995367bf2037de0159d924/pygments-2.19.2.tar.gz", hash = "sha256:636cb2477cec7f8952536970bc533bc43743542f70392ae026374600add5b887", size = 4968631, upload-time = "2025-06-21T13:39:12.283Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/c7/21/705964c7812476f378728bdf590ca4b771ec72385c533964653c68e86bdc/pygments-2.19.2-py3-none-any.whl", hash = "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b", size = 1225217, upload-time = "2025-06-21T13:39:07.939Z" },
+]
+
+[[package]]
+name = "pytest"
+version = "9.0.2"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "colorama", marker = "sys_platform == 'win32'" },
+    { name = "iniconfig" },
+    { name = "packaging" },
+    { name = "pluggy" },
+    { name = "pygments" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/d1/db/7ef3487e0fb0049ddb5ce41d3a49c235bf9ad299b6a25d5780a89f19230f/pytest-9.0.2.tar.gz", hash = "sha256:75186651a92bd89611d1d9fc20f0b4345fd827c41ccd5c299a868a05d70edf11", size = 1568901, upload-time = "2025-12-06T21:30:51.014Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/3b/ab/b3226f0bd7cdcf710fbede2b3548584366da3b19b5021e74f5bde2a8fa3f/pytest-9.0.2-py3-none-any.whl", hash = "sha256:711ffd45bf766d5264d487b917733b453d917afd2b0ad65223959f59089f875b", size = 374801, upload-time = "2025-12-06T21:30:49.154Z" },
+]