hashio 0.0.1__tar.gz

hashio-0.0.1/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: hashio
+Version: 0.0.1
+Summary: Custom file and directory checksum tool
+Home-page: http://github.com/rsgalloway/hashio
+Author: Ryan Galloway
+Author-email: ryan@rsgalloway.com
+License: BSD 3-Clause License
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+hashio
+======
+
+Custom file and directory checksum tool.
+
+## Features
+
+- multiple hash algos: c4, md5, sha256, sha512, xxh64
+- multiple export options (Default .json)
+- recursively runs checksums on files in directory trees
+- ignores predefined file name patterns
+- optionally caches results for better performance
+
+
+## Installation
+
+```bash
+$ pip install -U hashio
+```
+
+## Usage
+
+Basic usage:
+
+```bash
+hashio [-h] [--hash HASH [HASH ...]] [-t FILETYPE] [-o FILEPATH] [-a]
+       [-m] [-r] [--cache] [-v] [--version]
+       PATH [PATH ...]
+
+positional arguments:
+PATH                  one or more files or directories
+
+optional arguments:
+-h, --help            show this help message and exit
+--hash HASH [HASH ...]
+                        checksum algorithm (c4|md5|sha256|sha512|xxh64)
+-t FILETYPE, --filetype FILETYPE
+                        PATH is of type file (f) or dir (d) or all (a)
+-o FILEPATH, --outfile FILEPATH
+                        write results to output FILEPATH
+-a, --abs             use absolute paths
+-m, --metadata        include file metadata in output
+-r, --recursive       recurse directory structure
+--cache               cache checksum values while walking filesystem
+-v, --verify          verify checksum values in PATH
+--version             show program's version number and exit
+```
+
+## Examples
+
+Checksum one or more files or directories using one or more hash
+algorithms (default is xxh64):
+
+```bash
+$ hashio <PATH1>..<PATHN> [--hash <ALGO1>..<ALGON>]
+```
+
+Recursively checksum and gather metadata all the files in a dir
+tree, and output results to a JSON file:
+
+```bash
+$ hashio <DIR> -rm -o out.json
+```
+
+Note that files matching patterns defined in `$IGNORABLE` will be skipped.
+
+Verify paths in previously generated JSON file by comparing stored mtimes (if available) or regenerated hash values if mtimes are missing or different:
+
+```bash
+$ hashio --verify out.json
+```

hashio-0.0.1/README.md

@@ -0,0 +1,71 @@
+hashio
+======
+
+Custom file and directory checksum tool.
+
+## Features
+
+- multiple hash algos: c4, md5, sha256, sha512, xxh64
+- multiple export options (Default .json)
+- recursively runs checksums on files in directory trees
+- ignores predefined file name patterns
+- optionally caches results for better performance
+
+
+## Installation
+
+```bash
+$ pip install -U hashio
+```
+
+## Usage
+
+Basic usage:
+
+```bash
+hashio [-h] [--hash HASH [HASH ...]] [-t FILETYPE] [-o FILEPATH] [-a]
+       [-m] [-r] [--cache] [-v] [--version]
+       PATH [PATH ...]
+
+positional arguments:
+PATH                  one or more files or directories
+
+optional arguments:
+-h, --help            show this help message and exit
+--hash HASH [HASH ...]
+                        checksum algorithm (c4|md5|sha256|sha512|xxh64)
+-t FILETYPE, --filetype FILETYPE
+                        PATH is of type file (f) or dir (d) or all (a)
+-o FILEPATH, --outfile FILEPATH
+                        write results to output FILEPATH
+-a, --abs             use absolute paths
+-m, --metadata        include file metadata in output
+-r, --recursive       recurse directory structure
+--cache               cache checksum values while walking filesystem
+-v, --verify          verify checksum values in PATH
+--version             show program's version number and exit
+```
+
+## Examples
+
+Checksum one or more files or directories using one or more hash
+algorithms (default is xxh64):
+
+```bash
+$ hashio <PATH1>..<PATHN> [--hash <ALGO1>..<ALGON>]
+```
+
+Recursively checksum and gather metadata all the files in a dir
+tree, and output results to a JSON file:
+
+```bash
+$ hashio <DIR> -rm -o out.json
+```
+
+Note that files matching patterns defined in `$IGNORABLE` will be skipped.
+
+Verify paths in previously generated JSON file by comparing stored mtimes (if available) or regenerated hash values if mtimes are missing or different:
+
+```bash
+$ hashio --verify out.json
+```

hashio-0.0.1/lib/hashio/__init__.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2024, Ryan Galloway (ryan@rsgalloway.com)
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  - Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  - Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  - Neither the name of the software nor the names of its contributors
+#    may be used to endorse or promote products derived from this software
+#    without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+
+__doc__ = """
+Custom file and directory checksum tool.
+"""
+
+__prog__ = "hashio"
+__version__ = "0.0.1"

hashio-0.0.1/lib/hashio/cli.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2024, Ryan Galloway (ryan@rsgalloway.com)
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  - Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  - Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  - Neither the name of the software nor the names of its contributors
+#    may be used to endorse or promote products derived from this software
+#    without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+
+__doc__ = """
+Command line interface for hashio.
+"""
+
+import argparse
+import os
+import sys
+
+from hashio import __version__
+
+
+def parse_args():
+    """sys.argv parser, returns args."""
+
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.RawTextHelpFormatter
+    )
+    parser.add_argument(
+        "path",
+        type=str,
+        metavar="PATH",
+        nargs="?",
+        help="path to checksum",
+        default=os.getcwd(),
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version="%(prog)s {version}".format(version=__version__),
+    )
+
+    args = parser.parse_args()
+    return args
+
+
+def main():
+    """Main thread."""
+
+    parse_args()
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

hashio-0.0.1/lib/hashio.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.1
+Name: hashio
+Version: 0.0.1
+Summary: Custom file and directory checksum tool
+Home-page: http://github.com/rsgalloway/hashio
+Author: Ryan Galloway
+Author-email: ryan@rsgalloway.com
+License: BSD 3-Clause License
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+hashio
+======
+
+Custom file and directory checksum tool.
+
+## Features
+
+- multiple hash algos: c4, md5, sha256, sha512, xxh64
+- multiple export options (Default .json)
+- recursively runs checksums on files in directory trees
+- ignores predefined file name patterns
+- optionally caches results for better performance
+
+
+## Installation
+
+```bash
+$ pip install -U hashio
+```
+
+## Usage
+
+Basic usage:
+
+```bash
+hashio [-h] [--hash HASH [HASH ...]] [-t FILETYPE] [-o FILEPATH] [-a]
+       [-m] [-r] [--cache] [-v] [--version]
+       PATH [PATH ...]
+
+positional arguments:
+PATH                  one or more files or directories
+
+optional arguments:
+-h, --help            show this help message and exit
+--hash HASH [HASH ...]
+                        checksum algorithm (c4|md5|sha256|sha512|xxh64)
+-t FILETYPE, --filetype FILETYPE
+                        PATH is of type file (f) or dir (d) or all (a)
+-o FILEPATH, --outfile FILEPATH
+                        write results to output FILEPATH
+-a, --abs             use absolute paths
+-m, --metadata        include file metadata in output
+-r, --recursive       recurse directory structure
+--cache               cache checksum values while walking filesystem
+-v, --verify          verify checksum values in PATH
+--version             show program's version number and exit
+```
+
+## Examples
+
+Checksum one or more files or directories using one or more hash
+algorithms (default is xxh64):
+
+```bash
+$ hashio <PATH1>..<PATHN> [--hash <ALGO1>..<ALGON>]
+```
+
+Recursively checksum and gather metadata all the files in a dir
+tree, and output results to a JSON file:
+
+```bash
+$ hashio <DIR> -rm -o out.json
+```
+
+Note that files matching patterns defined in `$IGNORABLE` will be skipped.
+
+Verify paths in previously generated JSON file by comparing stored mtimes (if available) or regenerated hash values if mtimes are missing or different:
+
+```bash
+$ hashio --verify out.json
+```

hashio-0.0.1/lib/hashio.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+setup.py
+lib/hashio/__init__.py
+lib/hashio/cli.py
+lib/hashio.egg-info/PKG-INFO
+lib/hashio.egg-info/SOURCES.txt
+lib/hashio.egg-info/dependency_links.txt
+lib/hashio.egg-info/entry_points.txt
+lib/hashio.egg-info/not-zip-safe
+lib/hashio.egg-info/top_level.txt

hashio-0.0.1/lib/hashio.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hashio-0.0.1/lib/hashio.egg-info/entry_points.txt

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

hashio-0.0.1/lib/hashio.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

hashio-0.0.1/lib/hashio.egg-info/top_level.txt

@@ -0,0 +1 @@
+hashio

hashio-0.0.1/setup.cfg

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

hashio-0.0.1/setup.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2024, Ryan Galloway (ryan@rsgalloway.com)
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  - Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  - Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  - Neither the name of the software nor the names of its contributors
+#    may be used to endorse or promote products derived from this software
+#    without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+
+import os
+
+from setuptools import find_packages, setup
+
+here = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(here, "README.md")) as f:
+    long_description = f.read()
+
+
+setup(
+    name="hashio",
+    version="0.0.1",
+    description="Custom file and directory checksum tool",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Ryan Galloway",
+    author_email="ryan@rsgalloway.com",
+    url="http://github.com/rsgalloway/hashio",
+    license="BSD 3-Clause License",
+    classifiers=[
+        # How mature is this project? Common values are
+        #   3 - Alpha
+        #   4 - Beta
+        #   5 - Production/Stable
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+    ],
+    package_dir={"": "lib"},
+    packages=find_packages("lib"),
+    entry_points={
+        "console_scripts": [
+            "hashio=hashio.cli:main",
+        ],
+    },
+    python_requires=">=3.6",
+    zip_safe=False,
+)