***********
Checksumdir
***********
|badge1| |badge2|
.. |badge1| image:: https://img.shields.io/pypi/dm/checksumdir
:alt: PyPI - Downloads
:target: https://pypistats.org/packages/checksumdir
.. |badge2| image:: https://badge.fury.io/py/checksumdir.svg
:target: https://pypi.org/project/checksumdir/
A simple module for creating a single hash for a directory of files, with file contents;
ignoring any metadata such as file name. Options exist to also exclude specific files
or files with specific extensions.
=====
Usage
=====
.. code-block:: python
from checksumdir import dirhash
directory = '/path/to/directory/'
md5hash = dirhash(directory, 'md5')
sha1hash = dirhash(directory, 'sha1', excluded_files=['package.json'])
sha256hash = dirhash(directory, 'sha256', excluded_extensions=['pyc'])
Or to use the CLI:
.. code-block:: bash
# Defaults to md5.
$ checksumdir /path/to/directory
# Create sha1 hash:
$ checksumdir -a sha1 /path/to/directory
# Exclude files:
$ checksumdir -e <files> /path/to/directory
# Exclude files with specific extensions:
$ checksumdir -x <extensions> /path/to/directory
# Follow soft links:
$ checksumdir --follow-links /path/to/directory
Raw data
{
"_id": null,
"home_page": "http://github.com/cakepietoast/checksumdir",
"name": "checksumdir",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "hash, checksum, md5, directory",
"author": "Tom McCarthy",
"author_email": "tmac.se@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c4/cb/854df78940f24f099b2e2877dd4f32b9cae0c6bba3f2854bc6fc91ed5c6a/checksumdir-1.3.0.tar.gz",
"platform": null,
"description": "***********\nChecksumdir\n***********\n\n|badge1| |badge2|\n\n\n.. |badge1| image:: https://img.shields.io/pypi/dm/checksumdir \n :alt: PyPI - Downloads\n :target: https://pypistats.org/packages/checksumdir\n\n.. |badge2| image:: https://badge.fury.io/py/checksumdir.svg\n :target: https://pypi.org/project/checksumdir/\n\nA simple module for creating a single hash for a directory of files, with file contents;\nignoring any metadata such as file name. Options exist to also exclude specific files\nor files with specific extensions.\n\n=====\nUsage\n=====\n\n.. code-block:: python\n\n from checksumdir import dirhash\n\n directory = '/path/to/directory/'\n md5hash = dirhash(directory, 'md5')\n sha1hash = dirhash(directory, 'sha1', excluded_files=['package.json'])\n sha256hash = dirhash(directory, 'sha256', excluded_extensions=['pyc'])\n\n\nOr to use the CLI:\n\n.. code-block:: bash\n\n # Defaults to md5.\n $ checksumdir /path/to/directory\n\n # Create sha1 hash:\n $ checksumdir -a sha1 /path/to/directory\n\n # Exclude files:\n $ checksumdir -e <files> /path/to/directory\n\n # Exclude files with specific extensions:\n $ checksumdir -x <extensions> /path/to/directory\n\n # Follow soft links:\n $ checksumdir --follow-links /path/to/directory\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Compute a single hash of the file contents of a directory.",
"version": "1.3.0",
"project_urls": {
"Homepage": "http://github.com/cakepietoast/checksumdir"
},
"split_keywords": [
"hash",
" checksum",
" md5",
" directory"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "352e9b839f7f358f7fb26b9eba9214f7bdd592934d3707c564cecf842f2e8d82",
"md5": "c91a896f652103f047525b47a3bae09b",
"sha256": "29fd52a6258218752a3d8d2d7c998c6aca5d40dc6828fe1f7e98c631745da098"
},
"downloads": -1,
"filename": "checksumdir-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c91a896f652103f047525b47a3bae09b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 5491,
"upload_time": "2025-08-15T08:35:58",
"upload_time_iso_8601": "2025-08-15T08:35:58.015257Z",
"url": "https://files.pythonhosted.org/packages/35/2e/9b839f7f358f7fb26b9eba9214f7bdd592934d3707c564cecf842f2e8d82/checksumdir-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4cb854df78940f24f099b2e2877dd4f32b9cae0c6bba3f2854bc6fc91ed5c6a",
"md5": "f27e2d1d105b08f6a63efcb2c543220b",
"sha256": "11693641be49defbfdfb13612a7fd70ce1acd5401db74105f8c486fd72046540"
},
"downloads": -1,
"filename": "checksumdir-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "f27e2d1d105b08f6a63efcb2c543220b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 3563,
"upload_time": "2025-08-15T08:35:59",
"upload_time_iso_8601": "2025-08-15T08:35:59.134867Z",
"url": "https://files.pythonhosted.org/packages/c4/cb/854df78940f24f099b2e2877dd4f32b9cae0c6bba3f2854bc6fc91ed5c6a/checksumdir-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-15 08:35:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cakepietoast",
"github_project": "checksumdir",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "checksumdir"
}
JSON
