Auto generate class diagrams for IDTxl

IDTxl's dev folder contains UML class diagrams that are automatically generated from the source code using pyreverse (part of the pylint package).

By default, pyreverse creates two diagrams, packages_[packagename].* and classes_[packagename].*:

$ pyreverse -o svg -p idtxl [path2idtxl]/IDTxl/idtxl
[...]
creating diagram packages_idtxl.png
creating diagram classes_idtxl.png

• -o sets the output format
• -p [name] defines the target package

Call

pyreverse -f ALL -o svg -p idtxl [path2idtxl]/IDTxl/idtxl

to also include private methods and attributes. Other options are

-a N, -A    depth of research for ancestors
-s N, -S    depth of research for associated classes
-A, -S      all ancestors, resp. all associated
-m[yn]      add or remove the module name
-f MOD      filter the attributes : PUB_ONLY/SPECIAL/OTHER/ALL
-k          show only the classes (no attributes and methods)
-b          show 'builtin' objects
-c <class>  create  a  class  diagram  with  all classes related to
	    <class>  [current: none] the class must be in the  file
	    <modules>.  By default, this will include all ancestors
	    and associated classes of <class>  and  include  module
	    names (i.e. '-ASmy' ).

For all full list of settings, see the documentation