Metadata-Version: 2.1
Name: fastcrc
Version: 0.1.1
Summary: A hyper-fast Python module for computing CRC(16, 32, 64) checksum
Home-page: https://github.com/overcat/fastcrc
Author: overcat
Author-email: 4catcode@gmail.com
License: MIT License
Project-URL: Code, https://github.com/overcat/fastcrc
Project-URL: Issue tracker, https://github.com/overcat/fastcrc/issues
Keywords: crc,crc16,crc32,crc64
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python
Classifier: Programming Language :: Rust
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.6.0
License-File: LICENSE

=======
fastcrc
=======

.. image:: https://img.shields.io/readthedocs/fastcrc.svg?style=flat&maxAge=1800
    :alt: Read the Docs
    :target: https://fastcrc.readthedocs.io/en/latest/

.. image:: https://img.shields.io/pypi/v/fastcrc.svg?style=flat&maxAge=1800
    :alt: PyPI
    :target: https://pypi.python.org/pypi/fastcrc

.. image:: https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue?style=flat
    :alt: Python - Version
    :target: https://pypi.python.org/pypi/fastcrc

A hyper-fast Python module for computing CRC(16, 32, 64) checksum.


Installation
============

.. code-block:: text

   pip install fastcrc

Usage
=====

.. code:: python

   from fastcrc import crc16, crc32, crc64

   data = b"123456789"
   print(f"crc16 checksum with xmodem algorithm: {crc16.xmodem(data)}")
   print(f"crc32 checksum with aixm algorithm: {crc32.aixm(data)}")
   print(f"crc64 checksum with ecma_182 algorithm: {crc64.ecma_182(data)}")

Documentation
=============
fastcrc's documentation can be found at https://fastcrc.readthedocs.io

License
=======

fastcrc is licensed under `MIT License`_.

Thanks
=======

fastcrc is made possible by `crc-rs`_.

.. _MIT License: ./LICENSE
.. _crc-rs: https://github.com/mrhooray/crc-rs

