Merge pull request #22 from alimanfoo/zstd

Add Zstd, LZ4. Resolves #3.

Author: alimanfoo

MANIFEST.in

@@ -1,4 +1,6 @@
 recursive-include c-blosc *
 recursive-include numcodecs *.pyx
+recursive-include numcodecs *.pxd
 recursive-include numcodecs *.c
+recursive-include numcodecs *.h
 include cpuinfo.py

appveyor.yml

@@ -1,3 +1,7 @@
+branches:
+  only:
+    - master
+
 environment:
 
   global:

docs/index.rst

@@ -51,6 +51,8 @@ Contents
     abc
     registry
     blosc
+    lz4
+    zstd
     zlib
     bz2
     lzma

docs/lz4.rst

@@ -0,0 +1,10 @@
+LZ4
+===
+.. automodule:: numcodecs.lz4
+
+.. autoclass:: LZ4
+
+    .. autoattribute:: codec_id
+
+.. autofunction:: compress
+.. autofunction:: decompress

docs/release.rst

@@ -1,6 +1,19 @@
 Release notes
 =============
 
+.. _release_0.1.0:
+
+0.1.0
+-----
+
+TODO
+
+* Two new compressor codecs :class:`numcodecs.zstd.Zstd` and :class:`numcodecs.lz4.LZ4`
+  have been added (`#3 <https://github.com/alimanfoo/numcodecs/issues/3>`_,
+  `#22 <https://github.com/alimanfoo/numcodecs/issues/22>`_). These provide direct support for
+  compression/decompression using `Zstandard <https://github.com/facebook/zstd>`_ and
+  `LZ4 <https://github.com/lz4/lz4>`_ respectively.
+
 .. _release_0.0.1:
 
 0.0.1
@@ -19,7 +32,7 @@ the original Zarr module:
 
 * Codec classes have been re-organized into separate modules, mostly one per
   codec class, for ease of maintenance.
-* Two new codec classes have been added based on 32-bit checksums: CRC32 and
-  Adler32.
+* Two new codec classes have been added based on 32-bit checksums:
+  :class:`numcodecs.checksum32.CRC32` and :class:`numcodecs.checksum32.Adler32`.
 * The Blosc extension has been refactored to remove code duplications related
   to handling of buffer compatibility.

docs/zstd.rst

@@ -0,0 +1,10 @@
+Zstd
+====
+.. automodule:: numcodecs.zstd
+
+.. autoclass:: Zstd
+
+    .. autoattribute:: codec_id
+
+.. autofunction:: compress
+.. autofunction:: decompress

numcodecs/__init__.py

@@ -39,14 +39,28 @@
     pass
 
 try:
-    from numcodecs import blosc as _blosc
+    from numcodecs import blosc
     from numcodecs.blosc import Blosc
     register_codec(Blosc)
     # initialize blosc
     ncores = multiprocessing.cpu_count()
-    _blosc.init()
-    _blosc.set_nthreads(min(8, ncores))
-    atexit.register(_blosc.destroy)
+    blosc.init()
+    blosc.set_nthreads(min(8, ncores))
+    atexit.register(blosc.destroy)
+except ImportError:  # pragma: no cover
+    pass
+
+try:
+    from numcodecs import zstd
+    from numcodecs.zstd import Zstd
+    register_codec(Zstd)
+except ImportError:  # pragma: no cover
+    pass
+
+try:
+    from numcodecs import lz4
+    from numcodecs.lz4 import LZ4
+    register_codec(LZ4)
 except ImportError:  # pragma: no cover
     pass