docs/source/pluginwriter/api.rst

   1 .. MediaGoblin Documentation
   2
   3    Written in 2013 by MediaGoblin contributors
   4
   5    To the extent possible under law, the author(s) have dedicated all
   6    copyright and related and neighboring rights to this software to
   7    the public domain worldwide. This software is distributed without
   8    any warranty.
   9
  10    You should have received a copy of the CC0 Public Domain
  11    Dedication along with this software. If not, see
  12    <http://creativecommons.org/publicdomain/zero/1.0/>.
  13
  14
  15 ==========
  16 Plugin API
  17 ==========
  18
  19 This documents the general plugin API.
  20
  21 Please note, at this point OUR PLUGIN HOOKS MAY AND WILL CHANGE.
  22 Authors are encouraged to develop plugins and work with the
  23 MediaGoblin community to keep them up to date, but this API will be a
  24 moving target for a few releases.
  25
  26 Please check the release notes for updates!
  27
  28 :mod:`pluginapi` Module
  29 -----------------------
  30
  31 .. automodule:: mediagoblin.tools.pluginapi
  32    :members: get_config, register_routes, register_template_path,
  33              register_template_hooks, get_hook_templates,
  34              hook_handle, hook_runall, hook_transform