]> git.parisson.com Git - timeside.git/commitdiff
Update README
authorThomas Fillon <thomas@parisson.com>
Mon, 12 Jan 2015 14:44:38 +0000 (15:44 +0100)
committerThomas Fillon <thomas@parisson.com>
Mon, 12 Jan 2015 14:51:57 +0000 (15:51 +0100)
README.rst

index a6af65c45d91cc373be70d6d5052473158bebecf..95d1054049b90f73efac741b13835690714635d8 100644 (file)
@@ -60,15 +60,15 @@ Dive in
 
 To list all available plugins::
 
- import timeside
+ import timeside.core
  timeside.core.list_processors()
 
 Define some processors::
 
  from timeside.core import get_processor
  decoder  =  get_processor('file_decoder')('sweep.wav')
- grapher  =  get_processor('waveform_simple')
- analyzer =  get_processor('level')
+ grapher  =  get_processor('waveform_simple')()
+ analyzer =  get_processor('level')()
  encoder  =  get_processor('vorbis_encoder')('sweep.ogg')
 
 Then run the *magic* pipeline::
@@ -91,6 +91,16 @@ For more extensive examples, please see the `full documentation <http://files.pa
 News
 =====
 
+0.7
+
+ * Code refactoring:
+
+   - Create a new module `timeside.plugins` and move processors therein: timeside.plugins.decodr, timeside.plugins.analyzer, timeside.plugins.encoder, timeside.plugins.fx
+   - `timeside.plugins` is a `namespace package <https://pythonhosted.org/setuptools/setuptools.html#namespace-packages>`_ enabling external plugins to be automatically plug into TimeSide (see for example `timeside-diadems <https://github.com/ANR-DIADEMS/timeside-diadems>`_).
+   - To properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core`.
+ * Move all analyzers developped by the partners of the Diadems project to a new repository: `timeside-diadems <https://github.com/ANR-DIADEMS/timeside-diadems>`_
+
+
 0.6.1
 
   * Fix various minor bugs