Skip to content

Commit 38d9914

Browse files
authored
Merge pull request #25 from alimanfoo/release_v010
v0.1.0 release notes; add astype API docs
2 parents 36c75e0 + 73a620b commit 38d9914

File tree

3 files changed

+59
-1
lines changed

3 files changed

+59
-1
lines changed

docs/astype.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
AsType
2+
======
3+
.. automodule:: numcodecs.astype
4+
5+
.. autoclass:: AsType
6+
7+
.. autoattribute:: codec_id

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Contents
6161
packbits
6262
categorize
6363
checksum32
64+
astype
6465
pickles
6566
msgpacks
6667
release

docs/release.rst

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,63 @@ Release notes
66
0.1.0
77
-----
88

9-
TODO
9+
New codecs:
1010

1111
* Two new compressor codecs :class:`numcodecs.zstd.Zstd` and :class:`numcodecs.lz4.LZ4`
1212
have been added (`#3 <https://github.com/alimanfoo/numcodecs/issues/3>`_,
1313
`#22 <https://github.com/alimanfoo/numcodecs/issues/22>`_). These provide direct support for
1414
compression/decompression using `Zstandard <https://github.com/facebook/zstd>`_ and
1515
`LZ4 <https://github.com/lz4/lz4>`_ respectively.
16+
* A new :class:`numcodecs.msgpacks.MsgPack` codec has been added which uses
17+
`msgpack-python <https://github.com/msgpack/msgpack-python>`_ to perform encoding/decoding,
18+
including support for arrays of Python objects
19+
(`Jeff Reback <https://github.com/jreback>`_;
20+
`#5 <https://github.com/alimanfoo/numcodecs/issues/5>`_,
21+
`#6 <https://github.com/alimanfoo/numcodecs/issues/6>`_,
22+
`#8 <https://github.com/alimanfoo/numcodecs/issues/8>`_,
23+
`#21 <https://github.com/alimanfoo/numcodecs/issues/21>`_).
24+
* A new :class:`numcodecs.pickles.Pickle` codec has been added which uses the Python pickle protocol
25+
to perform encoding/decoding, including support for arrays of Python objects
26+
(`Jeff Reback <https://github.com/jreback>`_;
27+
`#5 <https://github.com/alimanfoo/numcodecs/issues/5>`_,
28+
`#6 <https://github.com/alimanfoo/numcodecs/issues/6>`_,
29+
`#21 <https://github.com/alimanfoo/numcodecs/issues/21>`_).
30+
* A new :class:`numcodecs.astype.AsType` codec has been added which uses NumPy to perform type
31+
conversion
32+
(`John Kirkham <https://github.com/jakirkham>`_;
33+
`#7 <https://github.com/alimanfoo/numcodecs/issues/7>`_,
34+
`#12 <https://github.com/alimanfoo/numcodecs/issues/12>`_,
35+
`#14 <https://github.com/alimanfoo/numcodecs/issues/14>`_).
36+
37+
Other new features:
38+
39+
* The :class:`numcodecs.lzma.LZMA` codec is now supported on Python 2.7 if
40+
`backports.lzma <https://pypi.python.org/pypi/backports.lzma>`_ is installed
41+
(`John Kirkham <https://github.com/jakirkham>`_;
42+
`#11 <https://github.com/alimanfoo/numcodecs/issues/11>`_,
43+
`#13 <https://github.com/alimanfoo/numcodecs/issues/13>`_).
44+
* The bundled c-blosc library has been upgraded to version
45+
`1.11.2 <https://github.com/Blosc/c-blosc/releases/tag/v1.11.2>`_
46+
(`#10 <https://github.com/alimanfoo/numcodecs/issues/10>`_,
47+
`#18 <https://github.com/alimanfoo/numcodecs/issues/18>`_).
48+
* An option has been added to the :class:`numcodecs.blosc.Blosc` codec to allow the block size to
49+
be manually configured
50+
(`#9 <https://github.com/alimanfoo/numcodecs/issues/9>`_,
51+
`#19 <https://github.com/alimanfoo/numcodecs/issues/19>`_).
52+
* The representation string for the :class:`numcodecs.blosc.Blosc` codec has been tweaked to
53+
help with understanding the shuffle option
54+
(`#4 <https://github.com/alimanfoo/numcodecs/issues/4>`_,
55+
`#19 <https://github.com/alimanfoo/numcodecs/issues/19>`_).
56+
57+
Maintenance work:
58+
59+
* CI tests now run under Python 3.6 as well as 2.7, 3.4, 3.5
60+
(`#16 <https://github.com/alimanfoo/numcodecs/issues/16>`_,
61+
`#17 <https://github.com/alimanfoo/numcodecs/issues/17>`_).
62+
* Test coverage is now monitored via
63+
`coveralls <https://coveralls.io/github/alimanfoo/numcodecs?branch=master>`_
64+
(`#15 <https://github.com/alimanfoo/numcodecs/issues/15>`_,
65+
`#20 <https://github.com/alimanfoo/numcodecs/issues/20>`_).
1666

1767
.. _release_0.0.1:
1868

0 commit comments

Comments
 (0)