Changes between Version 8 and Version 9 of AddOns


Ignore:
Timestamp:
06/15/12 19:23:43 (2 years ago)
Author:
mitar
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • AddOns

    v8 v9  
    33== Structure == 
    44 
    5 Add-on is a Python package. The structure of an add-ons repository is as follows, `packagename` being a directory of the add-on's Python package: 
     5Add-on is a [http://diveintopython3.ep.io/packaging.html Python package]. The structure of an add-ons repository is as follows, package name being a name of a directory of the add-on's Python package, often lowercased `addonname`: 
    66 
    77{{{ 
     
    1111    setup.py 
    1212    docs/ 
     13        Makefile 
     14        rst/ 
     15            conf.py 
     16            index.rst 
    1317    _packagename/ 
    1418        datasets/ 
     
    2327`docs` contains reST documentation of the add-on. `src` possible contains C/C++ source code. `datasets` any additional datasets add-on might use. 
    2428 
    25 Package name starts with `_` to signify it is for internal use only. Add-ons register through setuptools hook into Orange namespace. 
     29Package name starts with `_` to signify it is for internal use only. Add-ons register through setuptools hook into Orange namespace. Use relative imports to access other modules inside the package, if possible. 
    2630 
    27 [http://diveintopython3.ep.io/packaging.html More]. 
     31`setup.py`, `Makefile`, and `conf.py` as prepared in Biolab's add-ons can be used to get a good starting point for a new add-on.