Skip to content

Commit

Permalink
update docs for v1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
vsergeev committed Dec 9, 2013
1 parent cf36b35 commit e39c691
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 6 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion msgpack.org.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://msgpack.org/>`_ 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 <https://github.com/msgpack/msgpack/blob/master/spec.md>`_. 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 <http://msgpack.org/>`_ 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 <https://github.com/msgpack/msgpack/blob/master/spec.md>`_. 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",
Expand Down

0 comments on commit e39c691

Please sign in to comment.