simple-file-checksum


Namesimple-file-checksum JSON
Version 1.3.1 PyPI version JSON
download
home_pagehttps://github.com/sashsinha/simple-file-checksum
SummaryReturns the MD5, SHA1, SHA256, SHA384, or SHA512 checksum of a file.
upload_time2024-10-16 10:25:20
maintainerNone
docs_urlNone
authorSash Sinha
requires_python>=3.9
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <p align="center">
<a href="https://github.com/sashsinha/simple-file-checksum"><img alt="Simple File Checksum Logo" src="https://raw.githubusercontent.com/sashsinha/simple-file-checksum/main/logo.png"></a>
</p>

<h1 align="center">Simple File Checksum</h1>

<h3 align="center">Returns the MD5, SHA1, SHA256, SHA384, or SHA512 checksum of a file</h3>

<br/>

<p align="center">
<a href="https://github.com/sashsinha/simple-file-checksum/actions?query=workflow%3Atests"><img alt="Tests Badge" src="https://github.com/sashsinha/simple-file-checksum/workflows/tests/badge.svg"></a>
<a href="https://raw.githubusercontent.com/sashsinha/simple-file-checksum/main/LICENCE"><img alt="License: MIT" src="https://raw.githubusercontent.com/sashsinha/simple-file-checksum/main/license.svg"></a>
<a href="https://pypi.org/project/simple-file-checksum/"><img src="https://img.shields.io/badge/platform-windows%20%7C%20linux%20%7C%20macos-lightgrey" alt="Supported Platforms"></a>
<a href="https://pypi.org/project/simple-file-checksum/"><img 
alt="PyPI Supported Versions" src="https://img.shields.io/pypi/pyversions/simple-file-checksum.svg"></a>
<a href="https://pypi.org/project/simple-file-checksum/"><img alt="PyPI" src="https://img.shields.io/pypi/v/simple-file-checksum"></a>
<a href="https://pypi.org/project/simple-file-checksum/"><img alt="PyPI Status" src="https://img.shields.io/pypi/status/simple-file-checksum"></a>
<a href="https://pepy.tech/project/simple-file-checksum"><img alt="Downloads" src="https://pepy.tech/badge/simple-file-checksum"></a>

</p>

## Installation

Run the following to install:

```python
pip3 install simple-file-checksum
```

## Usage

### Python:

```python
>>> from simple_file_checksum import get_checksum
>>> get_checksum("tst/file.txt")
'9e107d9d372bb6826bd81d3542a419d6'
>>> get_checksum("tst/file.txt", algorithm="MD5")
'9e107d9d372bb6826bd81d3542a419d6'
>>> get_checksum("tst/file.txt", algorithm="SHA1")
'2fd4e1c67a2d28fced849ee1bb76e7391b93eb12'
>>> get_checksum("tst/file.txt", algorithm="SHA256")
'd7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592'
>>> get_checksum("tst/file.txt", algorithm="SHA384")
'ca737f1014a48f4c0b6dd43cb177b0afd9e5169367544c494011e3317dbf9a509cb1e5dc1e85a941bbee3d7f2afbc9b1'
>>> get_checksum("tst/file.txt", algorithm="SHA512")
'07e547d9586f6a73f73fbac0435ed76951218fb7d0c8d788a309d785436bbb642e93a252a954f23912547d1e8a3b5ed6e1bfd7097821233fa0538f3db854fee6'
```

### Terminal:

```bash
$ simple-file-checksum tst/file.txt
9e107d9d372bb6826bd81d3542a419d6
$ simple-file-checksum tst/file.txt -a MD5
9e107d9d372bb6826bd81d3542a419d6
$ simple-file-checksum tst/file.txt -a SHA1
2fd4e1c67a2d28fced849ee1bb76e7391b93eb12
$ simple-file-checksum tst/file.txt -a SHA256
d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592
$ simple-file-checksum tst/file.txt -a SHA384
ca737f1014a48f4c0b6dd43cb177b0afd9e5169367544c494011e3317dbf9a509cb1e5dc1e85a941bbee3d7f2afbc9b1
$ simple-file-checksum tst/file.txt -a SHA512
07e547d9586f6a73f73fbac0435ed76951218fb7d0c8d788a309d785436bbb642e93a252a954f23912547d1e8a3b5ed6e1bfd7097821233fa0538f3db854fee6
```

## Developing

To install `simple-file-checksum`, along with the tools you need to develop and run tests, run the following:

```bash
pip3 install -e ".[dev]"
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sashsinha/simple-file-checksum",
    "name": "simple-file-checksum",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Sash Sinha",
    "author_email": "sashsinha1@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b2/7b/71e950765fafaeb0b34116f50e736be8f0a96628e07d7d3f4d5e20ae54b3/simple_file_checksum-1.3.1.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n<a href=\"https://github.com/sashsinha/simple-file-checksum\"><img alt=\"Simple File Checksum Logo\" src=\"https://raw.githubusercontent.com/sashsinha/simple-file-checksum/main/logo.png\"></a>\n</p>\n\n<h1 align=\"center\">Simple File Checksum</h1>\n\n<h3 align=\"center\">Returns the MD5, SHA1, SHA256, SHA384, or SHA512 checksum of a file</h3>\n\n<br/>\n\n<p align=\"center\">\n<a href=\"https://github.com/sashsinha/simple-file-checksum/actions?query=workflow%3Atests\"><img alt=\"Tests Badge\" src=\"https://github.com/sashsinha/simple-file-checksum/workflows/tests/badge.svg\"></a>\n<a href=\"https://raw.githubusercontent.com/sashsinha/simple-file-checksum/main/LICENCE\"><img alt=\"License: MIT\" src=\"https://raw.githubusercontent.com/sashsinha/simple-file-checksum/main/license.svg\"></a>\n<a href=\"https://pypi.org/project/simple-file-checksum/\"><img src=\"https://img.shields.io/badge/platform-windows%20%7C%20linux%20%7C%20macos-lightgrey\" alt=\"Supported Platforms\"></a>\n<a href=\"https://pypi.org/project/simple-file-checksum/\"><img \nalt=\"PyPI Supported Versions\" src=\"https://img.shields.io/pypi/pyversions/simple-file-checksum.svg\"></a>\n<a href=\"https://pypi.org/project/simple-file-checksum/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/simple-file-checksum\"></a>\n<a href=\"https://pypi.org/project/simple-file-checksum/\"><img alt=\"PyPI Status\" src=\"https://img.shields.io/pypi/status/simple-file-checksum\"></a>\n<a href=\"https://pepy.tech/project/simple-file-checksum\"><img alt=\"Downloads\" src=\"https://pepy.tech/badge/simple-file-checksum\"></a>\n\n</p>\n\n## Installation\n\nRun the following to install:\n\n```python\npip3 install simple-file-checksum\n```\n\n## Usage\n\n### Python:\n\n```python\n>>> from simple_file_checksum import get_checksum\n>>> get_checksum(\"tst/file.txt\")\n'9e107d9d372bb6826bd81d3542a419d6'\n>>> get_checksum(\"tst/file.txt\", algorithm=\"MD5\")\n'9e107d9d372bb6826bd81d3542a419d6'\n>>> get_checksum(\"tst/file.txt\", algorithm=\"SHA1\")\n'2fd4e1c67a2d28fced849ee1bb76e7391b93eb12'\n>>> get_checksum(\"tst/file.txt\", algorithm=\"SHA256\")\n'd7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592'\n>>> get_checksum(\"tst/file.txt\", algorithm=\"SHA384\")\n'ca737f1014a48f4c0b6dd43cb177b0afd9e5169367544c494011e3317dbf9a509cb1e5dc1e85a941bbee3d7f2afbc9b1'\n>>> get_checksum(\"tst/file.txt\", algorithm=\"SHA512\")\n'07e547d9586f6a73f73fbac0435ed76951218fb7d0c8d788a309d785436bbb642e93a252a954f23912547d1e8a3b5ed6e1bfd7097821233fa0538f3db854fee6'\n```\n\n### Terminal:\n\n```bash\n$ simple-file-checksum tst/file.txt\n9e107d9d372bb6826bd81d3542a419d6\n$ simple-file-checksum tst/file.txt -a MD5\n9e107d9d372bb6826bd81d3542a419d6\n$ simple-file-checksum tst/file.txt -a SHA1\n2fd4e1c67a2d28fced849ee1bb76e7391b93eb12\n$ simple-file-checksum tst/file.txt -a SHA256\nd7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592\n$ simple-file-checksum tst/file.txt -a SHA384\nca737f1014a48f4c0b6dd43cb177b0afd9e5169367544c494011e3317dbf9a509cb1e5dc1e85a941bbee3d7f2afbc9b1\n$ simple-file-checksum tst/file.txt -a SHA512\n07e547d9586f6a73f73fbac0435ed76951218fb7d0c8d788a309d785436bbb642e93a252a954f23912547d1e8a3b5ed6e1bfd7097821233fa0538f3db854fee6\n```\n\n## Developing\n\nTo install `simple-file-checksum`, along with the tools you need to develop and run tests, run the following:\n\n```bash\npip3 install -e \".[dev]\"\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Returns the MD5, SHA1, SHA256, SHA384, or SHA512 checksum of a file.",
    "version": "1.3.1",
    "project_urls": {
        "Homepage": "https://github.com/sashsinha/simple-file-checksum"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a0ab977d3b5d910a53e59ecbb97b6f1b701bc4b4848a80384c264d010bbd5cca",
                "md5": "bab7a0ed15067824de09401c01c231d0",
                "sha256": "5c3f9519a3db4f12358a55c219c98ae4c1111d79f4e08c77715a626d1f6b4972"
            },
            "downloads": -1,
            "filename": "simple_file_checksum-1.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bab7a0ed15067824de09401c01c231d0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4625,
            "upload_time": "2024-10-16T10:25:19",
            "upload_time_iso_8601": "2024-10-16T10:25:19.184365Z",
            "url": "https://files.pythonhosted.org/packages/a0/ab/977d3b5d910a53e59ecbb97b6f1b701bc4b4848a80384c264d010bbd5cca/simple_file_checksum-1.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b27b71e950765fafaeb0b34116f50e736be8f0a96628e07d7d3f4d5e20ae54b3",
                "md5": "0656c3fb35eea6450a500de20c920281",
                "sha256": "fd5e083500f6e45daf252e9f5a62a3ddc622fd895e4bd68c4be89c7ddeec700e"
            },
            "downloads": -1,
            "filename": "simple_file_checksum-1.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0656c3fb35eea6450a500de20c920281",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 4217,
            "upload_time": "2024-10-16T10:25:20",
            "upload_time_iso_8601": "2024-10-16T10:25:20.740314Z",
            "url": "https://files.pythonhosted.org/packages/b2/7b/71e950765fafaeb0b34116f50e736be8f0a96628e07d7d3f4d5e20ae54b3/simple_file_checksum-1.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-16 10:25:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sashsinha",
    "github_project": "simple-file-checksum",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "simple-file-checksum"
}
Sash Sinha
Elapsed time: 0.62772s