crcutil 1.0.0__tar.gz

crcutil-1.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.11.6'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_TOKEN }}

crcutil-1.0.0/.gitignore

@@ -0,0 +1,171 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

crcutil-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CARLOS FLOREZ
+
+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.

crcutil-1.0.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.2
+Name: crcutil
+Version: 1.0.0
+Author-email: Carlos Florez <carlos@florez.co.uk>
+Maintainer-email: Carlos Florez <carlos@florez.co.uk>
+License: MIT License
+        
+        Copyright (c) 2025 CARLOS FLOREZ
+        
+        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.
+        
+Project-URL: Repository, https://github.com/florez-carlos/crcutil
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: alive-progress==3.1.5
+Requires-Dist: pyyaml==6.0.1
+Requires-Dist: toml==0.10.2
+Requires-Dist: pywin32==306; sys_platform == "win32"
+Requires-Dist: jsonschema==4.23.0
+Requires-Dist: colorlog==6.4.0
+Requires-Dist: pynput==1.7.7
+
+# CRCUtil
+Recursively traverses a given location and generates a hash.json containing a CRC value for every encountered file/dir
+
+> [!NOTE]
+> Installation is supported only for the following: 
+> - Windows
+> - Linux
+
+> [!NOTE]
+> Development requires a fully configured [Dotfiles](https://github.com/florez-carlos/dotfiles) dev environment <br>
+
+## Table of Contents
+
+* [Installation](#installation)
+  * [pip](#pip)
+* [Usage](#usage)
+  * [hash](#hash)
+  * [diff](#diff)
+  * [pause/resume](#pauseresume)
+* [Development](#development)
+
+## Installation
+### Pip
+```bash
+python3 -m pip install crcutil
+```
+
+## Usage
+
+### Hash
+
+-l The location for which to generate the hash
+
+```bash
+crcutil hash -l C:\DESIRED\PATH
+```
+This will generate a hash.json file in: <br >
+- Windows
+```bash
+C:\Users\<USERNAME>\Documents\crcutil\
+```
+- Linux
+```bash
+$HOME/crcutil
+```
+### Diff
+If you hold 2 hashes generated from the same directory and would like to compare the differences.
+
+-l The location of both hash files to compare
+
+```bash
+crcutil diff -l C:\HASH_FILE_1.json C:\HASH_FILE_2.json
+```
+
+This will compare both hash files and generate a diff.json in:
+- Windows
+```bash
+C:\Users\<USERNAME>\Documents\crcutil\
+```
+- Linux
+```bash
+$HOME/crcutil
+```
+### Pause/Resume 
+- The program can be paused/resumed at any time by pressing p, if a CRC is being calculated for a file
+you have to wait for the calculation to complete before the program can pause.
+- If you exit the program or it crashes unexpectedly mid operation, invoke the same command and the program will continue where it left off,
+as long as the hash file is not corrupted
+
+## Development
+
+> [!NOTE]
+> Development requires a fully configured [Dotfiles](https://github.com/florez-carlos/dotfiles) dev environment <br>
+
+```bash
+source init.sh
+```
+
+

crcutil-1.0.0/README.md

@@ -0,0 +1,79 @@
+# CRCUtil
+Recursively traverses a given location and generates a hash.json containing a CRC value for every encountered file/dir
+
+> [!NOTE]
+> Installation is supported only for the following: 
+> - Windows
+> - Linux
+
+> [!NOTE]
+> Development requires a fully configured [Dotfiles](https://github.com/florez-carlos/dotfiles) dev environment <br>
+
+## Table of Contents
+
+* [Installation](#installation)
+  * [pip](#pip)
+* [Usage](#usage)
+  * [hash](#hash)
+  * [diff](#diff)
+  * [pause/resume](#pauseresume)
+* [Development](#development)
+
+## Installation
+### Pip
+```bash
+python3 -m pip install crcutil
+```
+
+## Usage
+
+### Hash
+
+-l The location for which to generate the hash
+
+```bash
+crcutil hash -l C:\DESIRED\PATH
+```
+This will generate a hash.json file in: <br >
+- Windows
+```bash
+C:\Users\<USERNAME>\Documents\crcutil\
+```
+- Linux
+```bash
+$HOME/crcutil
+```
+### Diff
+If you hold 2 hashes generated from the same directory and would like to compare the differences.
+
+-l The location of both hash files to compare
+
+```bash
+crcutil diff -l C:\HASH_FILE_1.json C:\HASH_FILE_2.json
+```
+
+This will compare both hash files and generate a diff.json in:
+- Windows
+```bash
+C:\Users\<USERNAME>\Documents\crcutil\
+```
+- Linux
+```bash
+$HOME/crcutil
+```
+### Pause/Resume 
+- The program can be paused/resumed at any time by pressing p, if a CRC is being calculated for a file
+you have to wait for the calculation to complete before the program can pause.
+- If you exit the program or it crashes unexpectedly mid operation, invoke the same command and the program will continue where it left off,
+as long as the hash file is not corrupted
+
+## Development
+
+> [!NOTE]
+> Development requires a fully configured [Dotfiles](https://github.com/florez-carlos/dotfiles) dev environment <br>
+
+```bash
+source init.sh
+```
+
+

crcutil-1.0.0/git-hooks/commit-msg

@@ -0,0 +1,12 @@
+#!/bin/sh 
+
+commit_msg=$(cat "${1:?Missing commit message file}") 
+
+if ! echo "$commit_msg" | grep -Eq "^(build|chore|ci|docs|feat|feat!|fix|perf|refactor|revert|style|test)(\(.+\))?: .*$" ; then 
+    printf "%s\n" "Invalid commit message" 
+
+    exit 1 
+
+fi 
+
+echo "Commit message is valid!"

crcutil-1.0.0/git-hooks/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/bash
+shellcheck source.init.sh
+ruff check --fix
+ruff format

crcutil-1.0.0/init.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+color_red=$(tput setaf 1)
+color_green=$(tput setaf 2)
+color_yellow=$(tput setaf 3)
+color_normal=$(tput sgr0)
+setopt aliases
+
+
+required_python_version_path_name="3.11"
+required_python_version="3.11.6"
+
+if [ $UID -eq 0 ]; then
+    printf "%s\n" "${color_red}ERROR:${color_normal}Please DO NOT run this script with sudo"
+    return 1
+fi
+
+cp git-hooks/commit-msg ./.git/hooks 
+cp git-hooks/pre-commit ./.git/hooks
+
+current_python_version=$(python -V | sed 's/Python //;s/+//')
+if ! dpkg --compare-versions "$current_python_version" eq "$required_python_version";then
+    printf "%s\n" ""
+    printf "%s\n" "${color_red}ERROR${color_normal}: Current Python is $current_python_version but $required_python_version required"
+    printf "%s\n" ""
+    return 1
+fi
+
+python -m venv "$HOME"/venv/crcutil
+# shellcheck source=/dev/null
+. "$HOME"/venv/crcutil/bin/activate
+if [ "$VIRTUAL_ENV" != "$HOME"/venv/crcutil ]; then
+    printf "%s\n" ""
+    printf "%s\n" "${color_red}ERROR${color_normal}: Attempted to set venv to: $HOME/venv/crcutil but current venv is $VIRTUAL_ENV"
+    printf "%s\n" ""
+    return 1
+fi
+pip install -r requirements.txt
+
+export PYTHONPATH=$VIRTUAL_ENV/lib/python"$required_python_version_path_name"/site-packages/

crcutil-1.0.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=71.1.0","setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "crcutil"
+version = "1.0.0"
+requires-python = ">=3.11.6"
+authors = [
+  {name = "Carlos Florez", email = "carlos@florez.co.uk"}
+]
+maintainers = [
+  {name = "Carlos Florez", email = "carlos@florez.co.uk"}
+]
+description = ""
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+  "alive-progress==3.1.5",
+  "pyyaml==6.0.1",
+  "toml==0.10.2",
+  "pywin32==306;sys_platform == 'win32'",
+  "jsonschema==4.23.0",
+  "colorlog==6.4.0",
+  "pynput==1.7.7"
+]
+
+[project.scripts]
+crcutil = "crcutil.__main__:main"
+
+[project.urls]
+Repository = "https://github.com/florez-carlos/crcutil"

crcutil-1.0.0/requirements.txt

@@ -0,0 +1,7 @@
+alive-progress==3.1.5
+pyyaml==6.0.1
+toml==0.10.2
+pywin32==306;sys_platform == 'win32'
+jsonschema==4.23.0
+colorlog==6.4.0
+pynput==1.7.7

crcutil-1.0.0/ruff.toml

@@ -0,0 +1,40 @@
+line-length = 79
+indent-width = 4
+
+[lint]
+select = ["ALL"]
+ignore = ["D",
+"C901",
+"T201",
+"PLR0912",
+"PLR0913",
+"PLR0915",
+"SLF001",
+"FBT",
+"W191",
+"E111",
+"E114",
+"E117",
+"D206",
+"D300",
+"Q000",
+"Q001",
+"Q002",
+"Q003",
+"COM812",
+"COM819",
+"ISC001",
+"ISC002",
+"TRY003",
+"TRY004",
+"TRY300",
+"RET505",
+"RET506",
+]
+# select = ["E4", "E7", "E9", "F", "B", "Q"]
+# extend-select = ["E501"]
+
+[format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"

crcutil-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

crcutil-1.0.0/src/crcutil/__main__.py

@@ -0,0 +1,112 @@
+import json
+import sys
+
+from jsonschema.exceptions import ValidationError
+
+from crcutil.core.crc import Crc
+from crcutil.core.prompt import Prompt
+from crcutil.exception.bootstrap_error import BootstrapError
+from crcutil.exception.corrupt_hash_error import CorruptHashError
+from crcutil.exception.unexpected_argument_error import UnexpectedArgumentError
+from crcutil.exception.user_error import UserError
+from crcutil.util.crcutil_logger import CrcutilLogger
+from crcutil.util.file_importer import FileImporter
+
+
+def main() -> None:
+    try:
+        bootstrap_paths_dto = FileImporter.bootstrap()
+
+        log_dir = bootstrap_paths_dto.log_dir
+        hash_file_location = bootstrap_paths_dto.hash_file
+        report_file_location = bootstrap_paths_dto.report_file
+
+        log_config_file_path = (
+            FileImporter.get_project_root()
+            / "crcutil"
+            / "config"
+            / "log_config.yaml"
+        )
+
+        log_config = FileImporter.get_logging_config(log_config_file_path)
+
+        CrcutilLogger(log_dir, log_config)
+
+        instructions_dto = Prompt.get_user_instructions_dto()
+        location = instructions_dto.location
+        user_request = instructions_dto.request
+        hash_diff_files = instructions_dto.hash_diff_files
+        hash_diff_dtos = []
+        if hash_diff_files:
+            hash_diff_dtos = [
+                FileImporter.get_hash(x) for x in hash_diff_files
+            ]
+
+        crc_obj = Crc(
+            location=location,
+            hash_file_location=hash_file_location,
+            user_request=user_request,
+            hash_diff_1=hash_diff_dtos[0] if hash_diff_dtos else [],
+            hash_diff_2=hash_diff_dtos[1] if hash_diff_dtos else [],
+        )
+        hash_diff_report = crc_obj.do()
+        if hash_diff_report:
+            FileImporter.save_hash_diff_report(
+                report_file_location, hash_diff_report
+            )
+
+        sys.exit(0)
+
+    except SystemExit as e:
+        if e.code == 0:
+            description = "Successful System Exit"
+            CrcutilLogger.get_logger().debug(description)
+        else:
+            description = "\n=====Unexpected Error=====\n" f"{e!s}"
+            CrcutilLogger.get_logger().exception(description)
+            raise
+
+    except UnexpectedArgumentError as e:
+        sys.tracebacklimit = 0
+        description = (
+            "\n=====User Argument Error=====\n"
+            "These arguments are unrecognized: \n"
+        )
+        for argument in e.args[0]:
+            description += "-> " + argument + "\n"
+        CrcutilLogger.get_logger().error(description)
+        sys.exit(1)
+
+    except UserError as e:
+        sys.tracebacklimit = 0
+        description = "\n=====User Error=====\n" f"{e!s}"
+        CrcutilLogger.get_logger().error(description)
+
+    except CorruptHashError as e:
+        sys.tracebacklimit = 0
+        description = "\n=====Corrupt Hash Error=====\n" f"{e!s}"
+        CrcutilLogger.get_logger().error(description)
+
+    except json.decoder.JSONDecodeError as e:
+        sys.tracebacklimit = 0
+        description = "\n=====Corrupt Hash Error=====\n" f"{e!s}"
+        CrcutilLogger.get_logger().error(description)
+
+    except ValidationError as e:
+        sys.tracebacklimit = 0
+        description = "\n=====Invalid Schema Error=====\n" f"{e!s}"
+        CrcutilLogger.get_logger().error(description)
+
+    # No regular logger can be expected to be initialized
+    except BootstrapError as e:
+        description = "\n=====Program Initialization Error=====\n" f"{e!s}"
+        e.args = (description,)
+        raise
+
+    except Exception as e:  # noqa: BLE001
+        description = "\n=====Unexpected Error=====\n" f"{e!s}"
+        CrcutilLogger.get_logger().exception(description)
+
+
+if __name__ == "__main__":
+    main()