From e39c691e9160540281ba4639fbe0856a905d2010 Mon Sep 17 00:00:00 2001 From: Vanya Sergeev Date: Mon, 9 Dec 2013 03:43:24 -0800 Subject: [PATCH] update docs for v1.5 --- CHANGELOG.md | 5 +++++ README.md | 4 ++-- msgpack.org.md | 2 +- setup.py | 6 +++--- 4 files changed, 11 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f742a8a..9f7265a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +* Version 1.5 + * Hide internal helper functions from module's exported names. + * Make unit tests more portable among interpreters (CPython, PyPy). + * Update documentation for PyPy support. + * Version 1.4 * Add type checking to Ext class initialization. * Add support for Python 2.6. diff --git a/README.md b/README.md index 41a57bb..213f7ad 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# u-msgpack-python v1.4 +# u-msgpack-python v1.5 u-msgpack-python is a lightweight [MessagePack](http://msgpack.org/) serializer and deserializer module, compatible with both Python 2 and 3, as well CPython and PyPy implementations of Python. u-msgpack-python is fully compliant with the latest [MessagePack specification](https://github.com/msgpack/msgpack/blob/master/spec.md). In particular, it supports the new binary, UTF-8 string, and application ext types. @@ -81,7 +81,7 @@ b'\x01\x02\x03' ## Compatibility Mode -u-msgpack-python offers a compatibility mode for the [old specification](https://github.com/msgpack/msgpack/blob/master/spec-old.md) "raw" bytes msgpack type. When the compatibility mode is enabled, u-msgpack-python will serialize both unicode strings and bytes into the "raw" msgpack type, and deserialize the "raw" msgpack type into bytes. To enable compatibility mode, simply set the `compatibility` boolean of the umsgpack module to `True`. +u-msgpack-python offers a compatibility mode for the [old specification](https://github.com/msgpack/msgpack/blob/master/spec-old.md) to handle the old "raw" bytes msgpack type. When the compatibility mode is enabled, u-msgpack-python will serialize both unicode strings and bytes into the old "raw" msgpack type, and deserialize the "raw" msgpack type into bytes. To enable compatibility mode, simply set the `compatibility` boolean of the umsgpack module to `True`. ``` python >>> umsgpack.compatibility = True diff --git a/msgpack.org.md b/msgpack.org.md index 0ab1ad4..5045031 100644 --- a/msgpack.org.md +++ b/msgpack.org.md @@ -1,4 +1,4 @@ -# u-msgpack-python v1.4 +# u-msgpack-python v1.5 u-msgpack-python is a lightweight [MessagePack](http://msgpack.org/) serializer and deserializer module, compatible with both Python 2 and 3, as well CPython and PyPy implementations of Python. u-msgpack-python is fully compliant with the latest [MessagePack specification](https://github.com/msgpack/msgpack/blob/master/spec.md). diff --git a/setup.py b/setup.py index 1cb0b9a..095becc 100644 --- a/setup.py +++ b/setup.py @@ -2,13 +2,13 @@ setup( name='u-msgpack-python', - version='1.4', - description='A lightweight msgpack serializer and deserializer written in pure Python.', + version='1.5', + description='A portable, lightweight msgpack serializer and deserializer written in pure Python.', author='vsergeev', author_email='vsergeev at gmail', url='https://github.com/vsergeev/u-msgpack-python', py_modules=['umsgpack'], - long_description="""u-msgpack-python is a lightweight `MessagePack `_ serializer and deserializer module, compatible with both Python 2 and Python 3, as well as CPyhton and PyPy implementations of Python. u-msgpack-python is fully compliant with the latest `MessagePack specification `_. In particular, it supports the new binary, UTF-8 string, and application ext types. See https://github.com/vsergeev/u-msgpack-python for more information.""", + long_description="""u-msgpack-python is a lightweight `MessagePack `_ serializer and deserializer module written in pure Python, compatible with both Python 2 and Python 3, as well as CPython and PyPy implementations of Python. u-msgpack-python is fully compliant with the latest `MessagePack specification `_. In particular, it supports the new binary, UTF-8 string, and application ext types. See https://github.com/vsergeev/u-msgpack-python for more information.""", classifiers=[ "Development Status :: 5 - Production/Stable", "License :: OSI Approved :: MIT License",