5
Information on how to use plugins in Bazaar.
3
A plugin is an external component for Bazaar-NG that is typically made by
4
third parties. A plugin is capable of augmenting Bazaar-NG by adding or
5
replacing new or current functionality in Bazaar-NG. Plugins often work as
6
a way for developers to test new features for Bazaar-NG prior to inclusion
7
in the official codebase. Plugins can do a variety of things, including
9
A plugin is an external component for Bazaar that is typically made by
10
third parties. A plugin is capable of augmenting Bazaar by adding new
11
functionality. A plugin can also change current Bazaar behavior by
12
replacing current functionality. Plugins often work as a way for
13
developers to test new features for Bazaar prior to inclusion in the
14
official codebase. Plugins can do a variety of things, including
8
15
overriding commands, adding new commands, providing additional network
9
transports, customizing log output. The sky is the limit for the
16
transports, or customizing log output. The sky is the limit for the
10
17
customization that can be done through plugins.
12
19
Where to find Plugins
13
20
=====================
14
We keep our list of plugins on the http://bazaar-vcs.org/PluginRegistry page.
21
We keep our list of plugins on the http://bazaar-vcs.org/BzrPlugins page.
23
How to Install a plugin
24
=======================
25
Installing a plugin is very easy! One can either install a plugin
26
system-wide or on a per user basis. Both methods involve creating a
27
``plugins`` directory. Within this directory one can place plugins in
28
subdirectories. For example, ``plugins/bzrtools/``.
30
Two locations are currently checked: the bzrlib/plugins directory
31
(typically found in ``/usr/lib/python2.4/site-packages/bzrlib/plugins/``) and
32
``$HOME/.bazaar/plugins/``.
34
One can additionally override the home plugins by setting the environment
35
variable ``BZR_PLUGIN_PATH`` to a directory that contains plugins. The
36
installation of a plugin can be checked by running ``bzr plugins`` at
37
any time. New commands can be seen by running ``bzr help commands``.
38
The commands provided by a plugin are shown followed by the name of the
41
Plugins work particularly well with Bazaar branches. For example, to
42
install the bzrtools plugins for your main user account, one can perform
45
bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
46
~/.bazaar/plugins/bzrtools
48
When installing plugins the directories that you install them in must
49
be valid python identifiers. This means that they can only contain
50
certain characters, notably they cannot contain hyphens (``-``). Rather
51
than installing ``bzr-gtk`` to ``~/.bazaar/plugins/bzr-gtk``, install it
52
to ``~/.bazaar/plugins/gtk``.
20
58
but most plugins supply new commands.
22
60
To create a command, make a new object that derives from
23
`bzrlib.commands.Command`, and name it cmd_foo, where foo is the name of
61
``bzrlib.commands.Command``, and name it ``cmd_foo``, where foo is the name of
24
62
your command. If you create a command whose name contains an underscore,
25
63
it will appear in the UI with the underscore turned into a hyphen. For
26
example, "cmd_baz_import" will appear as "baz-import". For examples of how
27
to write commands, please see builtins.py.
64
example, `cmd_baz_import` will appear as `baz-import`. For examples of how
65
to write commands, please see ``builtins.py``.
29
67
Once you've created a command you must register the command with
30
`bzrlib.commands.register_command(cmd_foo)`. You must register the command
31
when your file is imported, otherwise bzr will not see it.
68
``bzrlib.commands.register_command(cmd_foo)``. You must register the
69
command when your file is imported, otherwise bzr will not see it.
33
Bzr will scan **bzrlib/plugins** and **~/.bazaar/plugins** for plugins by
34
default. You can override this with **BZR_PLUGIN_PATH**. Plugins may be
35
either modules or packages. If your plugin is a single file, you can
36
structure it as a module. If it has multiple files, or if you want to
37
distribute it as a bzr branch, you should structure it as a package, i.e. a
38
directory with an **__init__.py** file.
71
Bzr will scan ``bzrlib/plugins`` and ``~/.bazaar/plugins`` for plugins
72
by default. You can override this with ``BZR_PLUGIN_PATH``. Plugins
73
may be either modules or packages. If your plugin is a single file,
74
you can structure it as a module. If it has multiple files, or if you
75
want to distribute it as a bzr branch, you should structure it as a
76
package, i.e. a directory with an ``__init__.py`` file.
40
78
Please feel free to contribute your plugin to BzrTools, if you think it
41
79
would be useful to other people.
43
How to Install a plugin
44
=======================
45
Installing a plugin is very easy! One can either install a plugin
46
systemwide or on a user by user basis. Both methods involve create a
47
"plugins" directory. Within this directory one can place plugins in
48
subdirectories. For example, "plugins/bzrtools/".
50
Two locations are currently checked; the bzrlib/plugins directory
51
(typically found in /usr/lib/python2.4/site-packages/bzrlib/plugins/) and
52
$HOME/.bazaar/plugins/.
54
One can additionally override the home plugins by setting the environment
55
variable BZR_PLUGIN_PATH to a directory that contains plugins. The
56
installation of a plugin can be checked by running **bzr plugins** at
57
any time. New commands can be seen by running **bzr help commands**.
59
Plugins work particularly well with Bazaar-NG branches. For example, to
60
install the bzrtools plugins for your main user account, one can perform
63
bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
64
~/.bazaar/plugins/bzrtools
added
removed
doc/en/user-guide/plugins.txt
