renamed examples again, expanded readme

Author: Tillsten

MANIFEST

@@ -8,8 +8,10 @@ qtdataflow\model.py
 qtdataflow\view.py
 qtdataflow\examples\__init__.py
 qtdataflow\examples\example.py
-qtdataflow\examples\example2.py
+qtdataflow\examples\example_all_together.py
+qtdataflow\examples\example_matplotlib_on_canvas.py
 qtdataflow\examples\example_pyqtgraph.py
+qtdataflow\examples\example_widget_on_canvas.py
 qtdataflow\examples\icons\onebit_11.png
 qtdataflow\examples\icons\onebit_16.png
 qtdataflow\examples\icons\onebit_31.png

README.rst

@@ -3,13 +3,17 @@ qt-dataflow
 ===========
 This package tries to provide components for building your own
 visual programming environment. The authors aim is to make his
-data analysis programmes available to his colleagues who don't
+data analysis tool available to his colleagues who don't
 know programming or Python.
+
 Because a standard gui is not very flexible, this projects tries
-to make visual canvas on which the dataflow is defined. Extensibility
-is given through simply adding or modifying Nodes.
+to make visual canvas on which the dataflow can be defined and modified.
+Extensibility is given through simply adding or modifying Nodes.
+
+
 This project is inspired by Orange - where i did not see an easy way to just
-use the canvas part (also: license differences).
+use the canvas part (also: license differences). Also the design tries
+to be more flexible.
 
 
 Requirements
@@ -18,19 +22,63 @@ It is made with Python 2.7. Not tested for lower versions or
 Python 3 (patches welcome). It should work with PySide and PyQt,
 but at the moment, the imports need to be manually changed.
 
-The example has additional requirements:
+The examples have additional requirements:
    * numpy
    * matplotlib
+   * pyqtgraph for the pyqtgraph example
 
-Usage
------
-See example.py for an easy example using icons whic react to double click.
+Examples
+--------
+See example.py for an simple example using icons whic react to double click.
 Hold the mousebutton to connect node Termials (only out-> in is allowed).
 
 .. image:: https://github.com/Tillsten/qt-dataflow/raw/master/example.png
 
-Example2 uses widgets directly, also uses callback to propagate changes.
-Warning, there is no circular detection yet.
+example_widget uses widgets on the canvas directly, it also show how to make
+
+example_pyqtgraph need also the pyqtgraph package. It plot directly on the
+canvas.
+
+example_matplotlib_on_canvas does the same, but uses matplotlib via
+a temporary file.
+
+Code Example
+------------
+To make custom nodes you need to subclass Node. It must return
+a NodeView via its 'get_view' method. The following example
+implements a Node which make a random number.
+
+```python
+class RandomNumber(Node):
+    """
+    A test node which outputs a random number. Widget allow to set the number.
+    """
+    def __init__(self):
+        super(DataGenNode, self).__init__()
+        #Node type/name
+        self.node_type = 'Random Array'
+        #Icon_path is needed for the PixmapNodeView
+        self.icon_path = 'icons/onebit_11.png'
+        #The makes the node have an output terminal.
+        self.generates_output = True
+
+    def get_view(self):
+        return PixmapNodeView(self)
+
+    def get(self):
+        #Method which can be called by other nodes. The name is just
+        #a convention.
+        num = [random.random() for i in range(self.num_points)]
+        return num
+
+    def show_widget(self):
+        #Method called by double clicking on the icon.
+        int, ok = Qt.QtGui.QInputDialog.getInteger(None, 'Input Dialog',
+                                          'Number of Points', self.num_points)
+        if ok:
+            self.num_points = int
+```
+
 
 
 Structure
@@ -58,7 +106,7 @@ Todo
 
 Coding Style
 ------------
-This projects trys to follow PEP8.
+This projects tries to follow PEP8.
 
 License
 -------

qtdataflow/examples/example_all_together.py

@@ -0,0 +1 @@
+__author__ = 'Tillsten'

qtdataflow/examples/example_widget_on_canvas.py renamed to qtdataflow/examples/example_widget.py

@@ -8,8 +8,9 @@
 from distutils.core import setup
 
 setup(name='qt-dataflow',
-      version='0.2.1',
+      version='0.2.2',
       description='A base for custom visual programming enviroments',
+      long_description = open('README.rst', 'rt').read(),
       author='Till Stensitzki',
       author_email='tillsten@zedat.fu-berlin.de',
       url='https://github.com/Tillsten/qt-dataflow',