Getting ready for release 2.0.0

Author: martaiborra

ANNOUNCE.rst

@@ -0,0 +1,66 @@
+Announcing python-blosc2 2.0.0
+==============================
+
+Changes from python-blosc to python-blosc2
+------------------------------------------
+
+* The functions `compress_ptr` and `decompress_ptr` are replaced by pack and unpack since Pickle protocol 5 comes with out-of-band data.
+* The function `pack_array` is equivalent to `pack`, which accepts any object with attributes `itemsize` and `size`.
+* On the other hand, the function `unpack` doesn't return a numpy array whereas the `unpack_array` builds that array.
+* The `blosc.NOSHUFFLE` is replaced by the `blosc2.NOFILTER`
+
+
+
+
+
+In this release the package is compiled using the scikit-build tool
+for a better integration
+with the C dependencies.
+
+
+For more info, you can have a look at the release notes in:
+
+https://github.com/Blosc/python-blosc2/releases
+
+More docs and examples are available in the documentation site:
+
+https://python-blosc2.rtfd.io
+
+
+## What is it?
+
+Blosc is an open source high performance compressor optimized for binary data
+(i.e. floating point numbers, integers and booleans). It has
+been designed to transmit data to the processor cache faster
+than the traditional, non-compressed, direct memory fetch approach
+via a memcpy() OS call. Blosc main goal is not just to reduce the
+size of large datasets
+on-disk or in-memory, but also to accelerate memory-bound computations.
+
+
+python-blosc2 is a pythonic wrapper for the c-blosc2 library.
+
+
+## Sources repository
+
+The sources and documentation are managed through github services at:
+
+http://github.com/Blosc/c-blosc2
+
+c-blosc2 is distributed using the BSD license, see
+[LICENSE](https://github.com/Blosc/c-blosc2/blob/master/LICENSE.txt)
+for details.
+
+
+## Mailing list
+
+There is an official Blosc mailing list where discussions about
+c-blosc2 are welcome:
+
+[email protected]
+
+http://groups.google.es/group/blosc
+
+
+Enjoy Data!
+- The Blosc Development Team

RELEASING.rst

@@ -0,0 +1,105 @@
+python-blosc2 release procedure
+===============================
+
+Preliminaries
+-------------
+
+* Make sure that the current master branch is passing the tests on Microsoft Azure.
+
+* Make sure that `RELEASE_NOTES.rst` and `ANNOUNCE.rst` are up to date with the latest news
+  in the release.
+
+* Check that `VERSION` file contains the correct number.
+
+* Check any copyright listings and update them if necessary. You can use ``grep
+  -i copyright`` to figure out where they might be.
+
+* Commit the changes::
+
+    git commit -a -m "Getting ready for release X.Y.Z"
+    git push
+
+* Check that the documentation is correctly created in https://python-blosc2.rtfd.io.
+
+
+Tagging
+-------
+
+* Create a signed tag ``X.Y.Z`` from ``master``.  Use the next message::
+
+    git tag -a vX.Y.Z -m "Tagging version X.Y.Z"
+
+* Push the tag to the github repo::
+
+    git push
+    git push --tags
+
+After the tag would be up, update the release notes in: https://github.com/Blosc/python-blosc2/releases
+
+Packaging
+---------
+
+* Make sure that you are in a clean directory.  The best way is to
+  re-clone and re-build::
+
+    cd /tmp
+    git clone --recursive [email protected]:Blosc/python-blosc2.git
+    cd python-blosc2
+    python setup.py build_ext
+
+* Check that all Cython generated ``*.c`` files are present.
+
+* Make the tarball with the command::
+
+    python setup.py sdist
+    pip install dist/*
+
+Do a quick check that the tarball is sane.
+
+
+Uploading
+---------
+
+* Register and upload it also in the PyPi repository::
+
+    twine upload dist/*
+
+
+It takes about 15 minutes for it to be installed using::
+
+    pip install blosc2
+
+
+
+Announcing
+----------
+
+* Send an announcement to the Blosc list.  Use the ``ANNOUNCE.rst`` file as skeleton
+  (or possibly as the definitive version).
+
+* Announce in Twitter via @Blosc2 account and rejoice.
+
+
+Post-release actions
+--------------------
+
+* Change back to the actual python-blosc2 repo::
+
+    cd $HOME/blosc/python-blosc2
+
+
+* Create new headers for adding new features in ``RELEASE_NOTES.rst``
+  add this place-holder:
+
+  XXX version-specific blurb XXX
+
+* Edit ``VERSION`` in master to increment the version to the next
+  minor one (i.e. X.Y.Z --> X.Y.(Z+1).dev0).
+
+* Commit your changes with::
+
+    git commit -a -m "Post X.Y.Z release actions done"
+    git push
+
+
+That's all folks!

bench/compress_numpy.py

@@ -1,3 +1,11 @@
+########################################################################
+#
+#       Created: April 30, 2021
+#       Author:  The Blosc development team - [email protected]
+#
+########################################################################
+
+
 """
 Small benchmark that compares a plain NumPy array copy against
 compression through different compressors in blosc2.

bench/pack_compress.py

@@ -1,3 +1,11 @@
+########################################################################
+#
+#       Created: April 30, 2021
+#       Author:  The Blosc development team - [email protected]
+#
+########################################################################
+
+
 """
 Small benchmark that compares a plain NumPy array copy against
 compression through different compressors in blosc2.

bench/pack_unpack_deep.py

@@ -1,3 +1,11 @@
+########################################################################
+#
+#       Created: April 30, 2021
+#       Author:  The Blosc development team - [email protected]
+#
+########################################################################
+
+
 """
 Small benchmark that compares a plain NumPy array copy against
 compression through different compressors in blosc2.

blosc2/__init__.py

@@ -1,3 +1,11 @@
+########################################################################
+#
+#       Created: April 30, 2021
+#       Author:  The Blosc development team - [email protected]
+#
+########################################################################
+
+
 from .version import __version__
 
 # Codecs

blosc2/blosc2_ext.pyx

@@ -1,3 +1,11 @@
+########################################################################
+#
+#       Created: April 30, 2021
+#       Author:  The Blosc development team - [email protected]
+#
+########################################################################
+
+
 from libcpp cimport bool
 from libc.stdlib cimport malloc, free
 

blosc2/utils.py

@@ -1,3 +1,11 @@
+########################################################################
+#
+#       Created: April 30, 2021
+#       Author:  The Blosc development team - [email protected]
+#
+########################################################################
+
+
 import os
 import sys
 from . import blosc2_ext

examples/compress_decompress.py

@@ -1,3 +1,11 @@
+########################################################################
+#
+#       Created: April 30, 2021
+#       Author:  The Blosc development team - [email protected]
+#
+########################################################################
+
+
 # Compress and decompress different arrays
 import blosc2
 import array

examples/gil.py

@@ -1,3 +1,11 @@
+########################################################################
+#
+#       Created: April 30, 2021
+#       Author:  The Blosc development team - [email protected]
+#
+########################################################################
+
+
 import blosc2
 
 print(blosc2.set_releasegil(True))