Skip to content

Commit 56fc286

Browse files
committed
Merge pull request #117 from bastibe/documentation07
Update "Breaking Changes" section
2 parents efbade0 + f101ccd commit 56fc286

File tree

3 files changed

+16
-24
lines changed

3 files changed

+16
-24
lines changed

README.rst

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,11 @@ interface for Python calling C code. CFFI is supported for CPython 2.6+,
2121
Breaking Changes
2222
----------------
2323

24-
The latest release of PySoundFile cleans up many small
24+
PySoundFile has evolved rapidly during the last few releases. Most
25+
notably, we changed the import name from ``import pysoundfile`` to
26+
``import soundfile`` in 0.7. In 0.6, we cleaned up many small
2527
inconsistencies, particularly in the the ordering and naming of
26-
function arguments. Therefore, old code will probably not work any
27-
more.
28-
29-
It also adds a number of great new features, such as global ``read``
30-
and ``write`` functions that do not require you to open a
31-
``SoundFile``, or a ``blocks`` function that can read a sound file one
32-
block at a time. It has also grown a lot more flexible and powerful at
33-
opening things like streams, buffers, or file descriptors.
34-
35-
With all these improvements, we feel that the indexing interface is
36-
not needed any more. It is now officially marked as deprecated and
37-
might be removed in the future.
28+
function arguments and the removal of the indexing interface.
3829

3930
Installation
4031
------------
@@ -171,15 +162,6 @@ Here is an example using an HTTP request:
171162
f.seek(0)
172163
data, samplerate = sf.read(f)
173164
174-
Accessing File Metadata
175-
-----------------------
176-
177-
In addition to audio data, there are a number of text fields in some
178-
sound files. In particular, you can set a title, a copyright notice, a
179-
software description, the artist name, a comment, a date, the album
180-
name, a license, a track number and a genre. Note however, that not
181-
all of these fields are supported for every file format.
182-
183165
News
184166
----
185167

@@ -219,3 +201,13 @@ News
219201
- Added ``'x'`` open mode.
220202
- Added ``tell()`` method.
221203
- Added ``__repr__()`` method.
204+
205+
2015-04-xx V0.7.0 Bastian Bechtold:
206+
Again, thanks to Matthias Geier for all of his hard work, but also
207+
Nils Werner and Whistler7 for their many suggestions and help.
208+
209+
- Renamed ``import pysoundfile`` to ``import soundfile``.
210+
- Installation through pip wheels that contain the necessary
211+
libraries for OS X and Windows.
212+
- Removed ``exclusive_creation`` argument to ``write``.
213+
- Added ``truncate()`` method.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def run_tests(self):
4545

4646
setup(
4747
name='PySoundFile',
48-
version='0.6.0',
48+
version='0.7.0',
4949
description='An audio library based on libsndfile, CFFI and NumPy',
5050
author='Bastian Bechtold',
5151
author_email='[email protected]',

soundfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
For further information, see http://pysoundfile.readthedocs.org/.
99
1010
"""
11-
__version__ = "0.6.0"
11+
__version__ = "0.7.0"
1212

1313
import numpy as _np
1414
import os as _os

0 commit comments

Comments
 (0)