Add gzip_ng_threaded to documentation

Author: rhpvorderman

CHANGELOG.rst

@@ -9,6 +9,9 @@ Changelog
 
 version 0.4.0-dev
 -----------------
++ Add a ``gzip_ng_threaded`` module that contains the ``gzip_ng_threaded.open``
+  function. This allows using multithreaded compression as well as escaping the
+  GIL.
 + The internal ``gzip_ng._GzipReader`` has been rewritten in C. As a result the
   overhead of decompressing files has significantly been reduced.
 + The ``gzip_ng._GzipReader`` in C is now used in ``gzip_ng.decompress``. The

README.rst

@@ -42,7 +42,7 @@ by providing Python bindings for the zlib-ng library.
 This package provides Python bindings for the `zlib-ng
 <https://github.com/zlib-ng/zlib-ng>`_ library.
 
-``python-zlib-ng`` provides the bindings by offering two modules:
+``python-zlib-ng`` provides the bindings by offering three modules:
 
 + ``zlib_ng``: A drop-in replacement for the zlib module that uses zlib-ng to
   accelerate its performance.
@@ -51,6 +51,11 @@ This package provides Python bindings for the `zlib-ng
   instead of ``zlib`` to perform its compression and checksum tasks, which
   improves performance.
 
++ ``gzip_ng_threaded`` offers an ``open`` function which returns buffered read
+  or write streams that can be used to read and write large files while
+  escaping the GIL using one or multiple threads. This functionality only
+  works for streaming, seeking is not supported.
+
 ``zlib_ng`` and ``gzip_ng`` are almost fully compatible with ``zlib`` and
 ``gzip`` from the Python standard library. There are some minor differences
 see: differences-with-zlib-and-gzip-modules_.
@@ -68,6 +73,7 @@ The python-zlib-ng modules can be imported as follows
 
     from zlib_ng import zlib_ng
     from zlib_ng import gzip_ng
+    from zlib_ng import gzip_ng_threaded
 
 ``zlib_ng`` and ``gzip_ng`` are meant to be used as drop in replacements so
 their api and functions are the same as the stdlib's modules.

docs/index.rst

@@ -113,6 +113,13 @@ API-documentation: zlib_ng.gzip_ng
       :members:
       :special-members: __init__
 
+===========================================
+API-documentation: zlib_ng.gzip_ng_threaded
+===========================================
+
+.. automodule:: zlib_ng.gzip_ng_threaded
+   :members: open
+
 ===============================
 python -m zlib_ng.gzip_ng usage
 ===============================

src/zlib_ng/gzip_ng_threaded.py

@@ -2,7 +2,7 @@
 # 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022
 # Python Software Foundation; All Rights Reserved
 
-# This file is part of python-isal which is distributed under the
+# This file is part of python-zlib-ng which is distributed under the
 # PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2.
 
 import builtins
@@ -27,7 +27,7 @@ def open(filename, mode="rb", compresslevel=gzip_ng._COMPRESS_LEVEL_TRADEOFF,
     Comparable to gzip.open. This method is only usable for streamed reading
     and writing of objects. Seeking is not supported.
 
-    threads == 0 will defer to igzip.open. A threads < 0 will attempt to use
+    threads == 0 will defer to gzip_ng.open. A threads < 0 will attempt to use
     the number of threads in the system.
 
     :param filename: str, bytes or file-like object (supporting read or write
@@ -37,7 +37,7 @@ def open(filename, mode="rb", compresslevel=gzip_ng._COMPRESS_LEVEL_TRADEOFF,
     :param encoding: Passed through to the io.TextIOWrapper, if applicable.
     :param errors: Passed through to the io.TextIOWrapper, if applicable.
     :param newline: Passed through to the io.TextIOWrapper, if applicable.
-    :param threads: If 0 will defer to igzip.open, if < 0 will use all threads
+    :param threads: If 0 will defer to gzip_ng.open, if < 0 will use all threads
                     available to the system. Reading gzip can only
                     use one thread.
     :param block_size: Determines how large the blocks in the read/write