Metadata-Version: 2.1
Name: heatshrinkpy
Version: 0.11.0
Summary: Pure Python heatshrink library, based on heatshrink2 library
License: ISC
Author: Marcin Jaworski
Author-email: marcin@jaworski.me
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: importlib-metadata (>=6.6.0,<7.0.0) ; python_version < "3.8"
Description-Content-Type: text/x-rst

HeatshrinkPy
============

Compression using the `Heatshrink algorithm
<https://github.com/atomicobject/heatshrink>`__ in Python 3.

This library is a pure Python rewrite and a drop-in replacement of `heatshrink2 <https://github.com/eerimoq/pyheatshrink>`__ library.

It is significantly slower than the native one. It can be used as a fallback if building a native extension is not an
option.

Installation
------------

From PyPI:

.. code-block::

   $ pip install heatshrinkpy

Usage
-----

Please refer to the `heatshrink2 <https://github.com/eerimoq/pyheatshrink>`__ library for usage and documentation -
just replace heatshrink2 with heatshrinkpy where applicable.

License
-------

ISC license

