summaryrefslogtreecommitdiffstats
path: root/python/python3-lz4/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python3-lz4/README')
-rw-r--r--python/python3-lz4/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/python/python3-lz4/README b/python/python3-lz4/README
new file mode 100644
index 0000000000..270858e166
--- /dev/null
+++ b/python/python3-lz4/README
@@ -0,0 +1,12 @@
+python3-lz4: provides python bindings for the LZ4 compression library.
+
+The python3 bindings provided in this package cover the frame format
+and the block format specifications. The frame format bindings are the
+recommended ones to use, as this guarantees interoperability with other
+implementations and language bindings.
+
+The API provided by the frame format bindings follows that of the LZMA,
+zlib, gzip and bzip2 compression libraries which are provided with the
+Python standard library. As such, these LZ4 bindings should provide a
+drop-in alternative to the compression libraries shipped with Python.
+The package provides context managers and file handler support.