Metadata-Version: 2.2
Name: chicky
Version: 0.2.0
Summary: A simple tool to create checksum for files from a directory
Home-page: https://github.com/sveetch/chicky
Author: David Thenon
Author-email: sveetch@gmail.com
License: MIT
Project-URL: Source Code, https://github.com/sveetch/chicky
Project-URL: Issue Tracker, https://github.com/sveetch/chicky/issues
Project-URL: Changelog, https://chicky.readthedocs.io/en/latest/history.html
Project-URL: Documentation, https://chicky.readthedocs.io/
Keywords: Python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
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.8
Description-Content-Type: text/x-rst
License-File: LICENCE.txt
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: freezegun>=1.2.0; extra == "dev"
Provides-Extra: quality
Requires-Dist: flake8>=6.0.0; extra == "quality"
Requires-Dist: tox>=4.11.0; extra == "quality"
Provides-Extra: doc
Requires-Dist: sphinx>=8.0.2; extra == "doc"
Requires-Dist: furo>=2024.8.6; extra == "doc"
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
Requires-Dist: tabulate>=0.9.0; extra == "doc"
Provides-Extra: doc-live
Requires-Dist: livereload>=2.6.0; extra == "doc-live"
Provides-Extra: release
Requires-Dist: twine>=5.0.0; extra == "release"

.. _Python: https://www.python.org/

======
Chicky
======

Chicky is a tool to compute Blake2b checksums for files from a directory. It
will go recursively through the directory and collect every files that are elligibles.
Elligibility is determined from optional filters.

We tried to make it lightweight and efficient since it could be involved in continuous
integration pipelines.

Usage is simple: ::

    chicky mydirectory

That would output something like: ::

    {
        "created": "2025-01-15T10:00:00",
        "basedir": "mydirectory",
        "extensions": None,
        "files": {
            "empty.txt": "3345524abf6bbe1809449224b5972c41790b6cf2",
            "css/bootstrap.css": "b5b31416eb16e75e8d35469467229af5954d7ebf",
        }
    }

See documentation for more options and details.

Dependencies
************

The only dependency is `Python`_>=3.8 (currently tested on 3.8, 3.9, 3.10 and 3.11).

Links
*****

* Read the documentation on `Read the docs <https://chicky.readthedocs.io/>`_;
* Download its `PyPi package <https://pypi.python.org/pypi/chicky>`_;
* Clone it on its `Github repository <https://github.com/sveetch/chicky>`_;


Credits
*******

Logo vector and icon by `SVG Repo <https://www.svgrepo.com>`_.
