|
a/pyforge/docs/plugins.rst |
|
b/pyforge/docs/plugins.rst |
|
|
1 |
Writing Plugins for PyForge
|
|
|
2 |
=====================================================================
|
|
|
3 |
|
|
|
4 |
|
|
|
5 |
Writing applications that run in pyforge
|
|
|
6 |
---------------------------------------------------------------------
|
|
|
7 |
|
|
|
8 |
TODO: Basics of app writing here. HelloWiki tutorial in the
|
|
|
9 |
tutorials section.
|
|
|
10 |
|
|
|
11 |
|
|
|
12 |
Writing event listeners
|
|
|
13 |
---------------------------------------------------------------------
|
|
|
14 |
|
|
|
15 |
TODO: write about event listeners in general
|
|
|
16 |
|
|
|
17 |
Types of event hooks you can use:
|
|
|
18 |
|
|
|
19 |
* Immediate, best effort
|
|
|
20 |
* Queue based, will be processed (eventually)
|
|
|
21 |
|
|
|
22 |
Writing your own WebHooks
|
|
|
23 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
24 |
|
|
|
25 |
In general it's best to use a BusHook when writing web hooks
|
|
|
26 |
because you get higher performance and you don't slow down
|
|
|
27 |
the queue processing.
|
|
|
28 |
|
|
|
29 |
Extending the pyforge markup
|
|
|
30 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
31 |
|
|
|
32 |
There is a special kind of queue based pluging that allows you to
|
|
|
33 |
extend the standard artifact reference system to add new artifact
|
|
|
34 |
types (eg: sf:tg:ticket:149) and extend the syntax of our markup
|
|
|
35 |
language (based on Waylan Limberg's excellent markdown implementation
|
|
|
36 |
for python).
|
|
|
37 |
|
|
|
38 |
http://www.freewisdom.org/projects/python-markdown
|
|
|
39 |
|
|
|
40 |
|