crc8
====
.. image:: https://travis-ci.org/niccokunzmann/crc8.svg
:target: https://travis-ci.org/niccokunzmann/crc8
:alt: Build Status
.. image:: https://badge.fury.io/py/crc8.svg
:target: https://pypi.python.org/pypi/crc8
:alt: Python Package Version on Pypi
.. image:: https://img.shields.io/pypi/dm/crc8.svg
:target: https://pypi.python.org/pypi/crc8#downloads
:alt: Downloads from Pypi
A module that implements the CRC8 hash algorithm for Python 2 and 3.
Installation
------------
.. code:: bash
pip install crc8
Or copy the `crc8.py
<https://github.com/niccokunzmann/crc8/blob/master/crc8.py>`__ file somewhere
where you can import it.
Usage
-----
The ``crc8`` class has the same interface as the hash functions in the
`hashlib module
<https://docs.python.org/2/library/hashlib.html>`__.
Example:
.. code:: python
import crc8
hash = crc8.crc8()
hash.update(b'123')
assert hash.hexdigest() == 'c0'
assert hash.digest() == b'\xc0'
hash.reset()
assert hash.hexdigest() == '00'
Contribute
----------
If something s not there that you would like to have,
`open an issue <https://github.com/niccokunzmann/crc8/issues>`__,
`create a pull request <https://github.com/niccokunzmann/crc8/pulls>`__.
The license is `MIT
<https://github.com/niccokunzmann/crc8/blob/master/LICENSE>`__ and
I value contributions if you modify the code.
Release
-------
Install `twine <https://twine.readthedocs.io/en/stable/>`_.
.. code:: sh
python setup.py sdist
source .env # if you have stored TWINE_USERNAME and TWINE_PASSWORD
twine upload dist/*
Raw data
{
"_id": null,
"home_page": "https://github.com/niccokunzmann/crc8",
"name": "crc8",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "crc8 hash",
"author": "Nicco Kunzmann",
"author_email": "niccokunzmann@rambler.ru",
"download_url": "https://files.pythonhosted.org/packages/24/aa/f0701287e80d48e4c058fc5376398a8300bb61738ea7b11610769a47e702/crc8-0.2.0.tar.gz",
"platform": null,
"description": "crc8\n====\n\n.. image:: https://travis-ci.org/niccokunzmann/crc8.svg\n :target: https://travis-ci.org/niccokunzmann/crc8\n :alt: Build Status\n\n.. image:: https://badge.fury.io/py/crc8.svg\n :target: https://pypi.python.org/pypi/crc8\n :alt: Python Package Version on Pypi\n \n.. image:: https://img.shields.io/pypi/dm/crc8.svg\n :target: https://pypi.python.org/pypi/crc8#downloads\n :alt: Downloads from Pypi \n\n \nA module that implements the CRC8 hash algorithm for Python 2 and 3.\n\nInstallation\n------------\n\n.. code:: bash\n\n pip install crc8\n\nOr copy the `crc8.py\n<https://github.com/niccokunzmann/crc8/blob/master/crc8.py>`__ file somewhere\nwhere you can import it.\n\nUsage\n-----\n\nThe ``crc8`` class has the same interface as the hash functions in the \n`hashlib module\n<https://docs.python.org/2/library/hashlib.html>`__.\n\nExample:\n\n.. code:: python\n\n import crc8\n hash = crc8.crc8()\n hash.update(b'123')\n assert hash.hexdigest() == 'c0'\n assert hash.digest() == b'\\xc0'\n hash.reset()\n assert hash.hexdigest() == '00'\n\nContribute\n----------\n\nIf something s not there that you would like to have, \n`open an issue <https://github.com/niccokunzmann/crc8/issues>`__, \n`create a pull request <https://github.com/niccokunzmann/crc8/pulls>`__.\n\nThe license is `MIT\n<https://github.com/niccokunzmann/crc8/blob/master/LICENSE>`__ and\nI value contributions if you modify the code.\n\n\nRelease\n-------\n\nInstall `twine <https://twine.readthedocs.io/en/stable/>`_.\n\n.. code:: sh\n\n python setup.py sdist\n source .env # if you have stored TWINE_USERNAME and TWINE_PASSWORD\n twine upload dist/*\n \n \n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A module that implements the CRC8 hash algorithm for Python 2 and 3.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/niccokunzmann/crc8"
},
"split_keywords": [
"crc8",
"hash"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "24aaf0701287e80d48e4c058fc5376398a8300bb61738ea7b11610769a47e702",
"md5": "9f35bb28b8f4a69a7847c0556328bcdf",
"sha256": "3c34d0a006ae8ddecfd744ae585eac95120915bf0770011aee9250017c0c40f1"
},
"downloads": -1,
"filename": "crc8-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "9f35bb28b8f4a69a7847c0556328bcdf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5892,
"upload_time": "2023-07-05T12:52:02",
"upload_time_iso_8601": "2023-07-05T12:52:02.885706Z",
"url": "https://files.pythonhosted.org/packages/24/aa/f0701287e80d48e4c058fc5376398a8300bb61738ea7b11610769a47e702/crc8-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-05 12:52:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "niccokunzmann",
"github_project": "crc8",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "crc8"
}
JSON
