doc/plugin.rst

   1 Plugin architecture
   2 ===================
   3
   4 :Author: Edward Z. Yang <ezyang@mit.edu>
   5
   6 Wizard uses the standard :mod:`pkg_resources` plugin infrastructure from
   7 `setuptools <http://pypi.python.org/pypi/setuptools>`_ to add support
   8 for plugins in Wizard.  We recommend the following excellent tutorials
   9 in for learning how to register plugins using this infrastructure:
  10
  11 * `Using Entry Points to Write Plugins
  12   <http://pylonshq.com/docs/en/0.9.7/advanced_pylons/entry_points_and_plugins/>`_
  13 * `Dynamic Discovery of Services and Plugins
  14   <http://peak.telecommunity.com/DevCenter/setuptools#dynamic-discovery-of-services-and-plugins>`_
  15
  16 .. todo::
  17
  18     Describe how to register plugins without actually have to install
  19     any eggs.
  20
  21 Here is a bird's eye view of the various plugin systems in Wizard.
  22
  23 :mod:`wizard.app`
  24 -----------------
  25
  26 Use ``wizard.app`` to register custom applications that Wizard has
  27 support for.  Key is user-visible name of application (e.g.
  28 ``wordpress``) and value is application class to be instantiated to
  29 represent this application (e.g. ``wizard.app.wordpress:Application``).