Introduction
============
.. image:: https://readthedocs.org/projects/hashlib/badge/?version=latest
:target: https://docs.circuitpython.org/projects/hashlib/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_hashlib/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_hashlib/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
This module implements a common interface to many different secure hash and message digest algorithms.
Included are the FIPS secure hash algorithms SHA1, SHA224, SHA256, SHA384, and SHA512 (defined in FIPS 180-2)
as well as RSA’s MD5 algorithm (defined in Internet RFC 1321).
The SHA1 algorithm is not supported by the CircuitPython module.
`This library is based on the work performed in the micropython-lib hashlib module by Paul Sokolovsky <https://github.com/micropython/micropython-lib/tree/master/hashlib>`_
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-hashlib/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-hashlib
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-hashlib
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-hashlib
Usage Example
=============
.. code-block:: python
import adafruit_hashlib as hashlib
m = hashlib.sha256()
m.update(b"CircuitPython")
print("Msg Hex Digest: {}\nMsg Digest Size: {}\nMsg Block Size: {}".format(
m.hexdigest(), m.digest_size, m.block_size))
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/hashlib/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_hashlib/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-hashlib",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,hashlib,hashes,,sha1,,sha224,,sha384,,sha512",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/68/44/ec93491d10eb76bb8ec535d053fa40696bdec69663ea07b00d2548c1f1c1/adafruit-circuitpython-hashlib-1.4.15.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/hashlib/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/hashlib/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_hashlib/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_hashlib/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nThis module implements a common interface to many different secure hash and message digest algorithms.\nIncluded are the FIPS secure hash algorithms SHA1, SHA224, SHA256, SHA384, and SHA512 (defined in FIPS 180-2)\nas well as RSA\u2019s MD5 algorithm (defined in Internet RFC 1321).\n\nThe SHA1 algorithm is not supported by the CircuitPython module.\n\n\n`This library is based on the work performed in the micropython-lib hashlib module by Paul Sokolovsky <https://github.com/micropython/micropython-lib/tree/master/hashlib>`_\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-hashlib/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-hashlib\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-hashlib\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-hashlib\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import adafruit_hashlib as hashlib\n m = hashlib.sha256()\n m.update(b\"CircuitPython\")\n print(\"Msg Hex Digest: {}\\nMsg Digest Size: {}\\nMsg Block Size: {}\".format(\n m.hexdigest(), m.digest_size, m.block_size))\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/hashlib/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_hashlib/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Secure hashes and message digests",
"version": "1.4.15",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_hashlib"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"hashlib",
"hashes",
"",
"sha1",
"",
"sha224",
"",
"sha384",
"",
"sha512"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57571e8c51604edf13cb5c3fab9a78cdd0db1ef78b93160f1046c01684ffb617",
"md5": "84b44b59701a6411a62ce79bac58b2aa",
"sha256": "d4e828d8288b32c00112d8aadbc7f4fe872efb0f4146554693f4b7ecd9756b36"
},
"downloads": -1,
"filename": "adafruit_circuitpython_hashlib-1.4.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "84b44b59701a6411a62ce79bac58b2aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19349,
"upload_time": "2023-12-09T17:44:58",
"upload_time_iso_8601": "2023-12-09T17:44:58.635482Z",
"url": "https://files.pythonhosted.org/packages/57/57/1e8c51604edf13cb5c3fab9a78cdd0db1ef78b93160f1046c01684ffb617/adafruit_circuitpython_hashlib-1.4.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6844ec93491d10eb76bb8ec535d053fa40696bdec69663ea07b00d2548c1f1c1",
"md5": "4c12978de8e5adc4fef8a9b083bde6b6",
"sha256": "7d9bb42ad946a53b88ba9b03089ee1d10358163db99517cfa297e523f55341d3"
},
"downloads": -1,
"filename": "adafruit-circuitpython-hashlib-1.4.15.tar.gz",
"has_sig": false,
"md5_digest": "4c12978de8e5adc4fef8a9b083bde6b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 36031,
"upload_time": "2023-12-09T17:45:03",
"upload_time_iso_8601": "2023-12-09T17:45:03.365386Z",
"url": "https://files.pythonhosted.org/packages/68/44/ec93491d10eb76bb8ec535d053fa40696bdec69663ea07b00d2548c1f1c1/adafruit-circuitpython-hashlib-1.4.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:45:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_hashlib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-hashlib"
}
JSON
