@@ -45,9 +45,19 @@ Acceleration Library (ISA-L) implements several key algorithms in `assembly
4545language <https://en.wikipedia.org/wiki/Assembly_language> `_. This includes
4646a variety of functions to provide zlib/gzip-compatible compression.
4747
48- ``python-isal `` provides the bindings by offering an ``isal_zlib `` and
49- ``igzip `` module which are usable as drop-in replacements for the ``zlib ``
50- and ``gzip `` modules from the stdlib (with some minor exceptions, see below).
48+ ``python-isal `` provides the bindings by offering three modules:
49+
50+ + ``isal_zlib ``: A drop-in replacement for the zlib module that uses ISA-L to
51+ accelerate its performance.
52+ + ``igzip ``: A drop-in replacement for the gzip module that uses
53+ ``isal_zlib `` instead of ``zlib `` to perform its compression
54+ tasks, which improves performance.
55+ + ``igzip_lib ``: Provides compression functions which have full access to the
56+ API of ISA-L's compression functions.
57+
58+ ``isal_zlib `` and ``igzip `` are almost fully compatible with ``zlib `` and
59+ ``gzip `` from the Python standard library. There are some minor differences
60+ which are listed below.
5161
5262.. introduction end
5363
@@ -56,15 +66,13 @@ Quickstart
5666
5767.. usage start
5868
59- Python-isal has faster versions of the stdlib's ``zlib `` and ``gzip `` module
60- these are called ``isal_zlib `` and ``igzip `` respectively.
61-
62- They can be imported as follows
69+ The python-isal modules can be imported as follows
6370
6471.. code-block :: python
6572
6673 from isal import isal_zlib
6774 from isal import igzip
75+ from isal import igzip_lib
6876
6977 ``isal_zlib `` and ``igzip `` are meant to be used as drop in replacements so
7078their api and functions are the same as the stdlib's modules. Except where
@@ -144,8 +152,8 @@ This project builds upon the software and experience of many. Many thanks to:
144152 to create an extension and helping a novice get start with pointer addresses.
145153+ The `CPython contributors
146154 <https://github.com/python/cpython/graphs/contributors> `_.
147- Python-isal mimicks ``zlibmodule.c `` and ``igzip .py `` to make it easier for
148- python users to adopt it.
155+ Python-isal mimicks ``zlibmodule.c `` and ``gzip .py `` from the standard
156+ library to make it easier for python users to adopt it.
149157+ `@marcelm <https://github.com/marcelm >`_ for taking a chance on this project
150158 and make it a dependency for his `xopen
151159 <https://github.com/pycompression/xopen> `_ and by extension `cutadapt
0 commit comments