Skip to content

Commit 7159a5b

Browse files
committed
updated README for 0.6.0
1 parent 5e92d73 commit 7159a5b

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

README.rst

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ interface for Python calling C code. CFFI is supported for CPython 2.6+,
1818
| PySoundFile is BSD licensed (BSD 3-Clause License).
1919
| (c) 2013, Bastian Bechtold
2020
21+
22+
Breaking Changes
23+
----------------
24+
25+
The latest release of PySoundFile cleans up many small inconsistencies, particularly in the the ordering and naming of function arguments. Therefore, old code will probably not work any more.
26+
27+
It also adds a number of great new features, such as global ``read`` and ``write`` functions that do not require you to open a ``SoundFile``, or a ``blocks`` function that can read a sound file one block at a time. It has also grown a lot more flexible and powerful at opening things like streams, buffers, or file descriptors.
28+
29+
With all these improvements, we feel that the indexing interface is not needed any more. It is now officially marked as deprecated and might be removed in the future.
30+
2131
Installation
2232
------------
2333

@@ -39,16 +49,16 @@ manager, for example ``sudo apt-get install libsndfile``.
3949

4050
With CFFI, Numpy, and libsndfile installed, you can use `pip
4151
<http://pip.readthedocs.org/en/latest/installing.html>`__ to install
42-
`PySoundFile <https://pypi.python.org/pypi/PySoundFile/0.5.0>`__ with
52+
`PySoundFile <https://pypi.python.org/pypi/PySoundFile/0.6.0>`__ with
4353
``pip install pysoundfile`` or ``pip install pysoundfile --user`` if you
4454
don't have administrator privileges. If you are running Windows you
4555
should download the Windows installers for PySoundFile instead (which
4656
also include libsndfile):
4757

48-
| `PySoundFile-0.5.0.win-amd64-py2.7 <https://github.com/bastibe/PySoundFile/releases/download/0.5.0/PySoundFile-0.5.0.win-amd64-py2.7.exe>`__
49-
| `PySoundFile-0.5.0.win-amd64-py3.3 <https://github.com/bastibe/PySoundFile/releases/download/0.5.0/PySoundFile-0.5.0.win-amd64-py3.3.exe>`__
50-
| `PySoundFile-0.5.0.win32-py2.7 <https://github.com/bastibe/PySoundFile/releases/download/0.5.0/PySoundFile-0.5.0.win32-py2.7.exe>`__
51-
| `PySoundFile-0.5.0.win32-py3.3 <https://github.com/bastibe/PySoundFile/releases/download/0.5.0/PySoundFile-0.5.0.win32-py3.3.exe>`__
58+
| `PySoundFile-0.6.0.win-amd64-py2.7 <https://github.com/bastibe/PySoundFile/releases/download/0.6.0/PySoundFile-0.6.0.win-amd64-py2.7.exe>`__
59+
| `PySoundFile-0.6.0.win-amd64-py3.4 <https://github.com/bastibe/PySoundFile/releases/download/0.6.0/PySoundFile-0.6.0.win-amd64-py3.4.exe>`__
60+
| `PySoundFile-0.6.0.win32-py2.7 <https://github.com/bastibe/PySoundFile/releases/download/0.6.0/PySoundFile-0.6.0.win32-py2.7.exe>`__
61+
| `PySoundFile-0.6.0.win32-py3.4 <https://github.com/bastibe/PySoundFile/releases/download/0.6.0/PySoundFile-0.6.0.win32-py3.4.exe>`__
5262
5363
Read/Write Functions
5464
--------------------
@@ -187,4 +197,16 @@ News
187197
Thanks to Xidorn Quan, FLAC files are not float32 any more.
188198

189199
2014-02-26 V0.5.0 Bastian Bechtold:
190-
Thanks to Matthias Geier, improved seeking.
200+
Thanks to Matthias Geier, improved seeking and a flush() method.
201+
202+
2015-01-19 V0.6.0 Bastian Bechtold:
203+
A big, big thank you to Matthias Geier, who did most of the work!
204+
205+
- Switched to ``float64`` as default data type.
206+
- Function arguments changed for consistency.
207+
- Added unit tests.
208+
- Added global ``read()``, ``write()``, ``blocks()`` convenience functions.
209+
- Documentation overhaul and hosting on readthedocs.
210+
- Added ``'x'`` open mode.
211+
- Added ``tell()`` method.
212+
- Added ``__repr__()`` method.

0 commit comments

Comments
 (0)