9
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 or
11
replacing new or current functionality in Bazaar. Plugins often work as
12
a way for developers to test new features for Bazaar prior to inclusion
13
in the official codebase. Plugins can do a variety of things, including
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
14
15
overriding commands, adding new commands, providing additional network
15
transports, customizing log output. The sky is the limit for the
16
transports, or customizing log output. The sky is the limit for the
16
17
customization that can be done through plugins.
18
19
Where to find Plugins
19
20
=====================
20
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.
26
27
but most plugins supply new commands.
28
29
To create a command, make a new object that derives from
29
`bzrlib.commands.Command`, and name it cmd_foo, where foo is the name of
30
``bzrlib.commands.Command``, and name it ``cmd_foo``, where foo is the name of
30
31
your command. If you create a command whose name contains an underscore,
31
32
it will appear in the UI with the underscore turned into a hyphen. For
32
example, "cmd_baz_import" will appear as "baz-import". For examples of how
33
to write commands, please see builtins.py.
33
example, `cmd_baz_import` will appear as `baz-import`. For examples of how
34
to write commands, please see ``builtins.py``.
35
36
Once you've created a command you must register the command with
36
`bzrlib.commands.register_command(cmd_foo)`. You must register the command
37
when your file is imported, otherwise bzr will not see it.
37
``bzrlib.commands.register_command(cmd_foo)``. You must register the
38
command when your file is imported, otherwise bzr will not see it.
39
Bzr will scan **bzrlib/plugins** and **~/.bazaar/plugins** for plugins by
40
default. You can override this with **BZR_PLUGIN_PATH**. Plugins may be
41
either modules or packages. If your plugin is a single file, you can
42
structure it as a module. If it has multiple files, or if you want to
43
distribute it as a bzr branch, you should structure it as a package, i.e. a
44
directory with an **__init__.py** file.
40
Bzr will scan ``bzrlib/plugins`` and ``~/.bazaar/plugins`` for plugins
41
by default. You can override this with ``BZR_PLUGIN_PATH``. Plugins
42
may be either modules or packages. If your plugin is a single file,
43
you can structure it as a module. If it has multiple files, or if you
44
want to distribute it as a bzr branch, you should structure it as a
45
package, i.e. a directory with an ``__init__.py`` file.
46
47
Please feel free to contribute your plugin to BzrTools, if you think it
47
48
would be useful to other people.
49
50
How to Install a plugin
50
51
=======================
51
52
Installing a plugin is very easy! One can either install a plugin
52
systemwide or on a user by user basis. Both methods involve create a
53
"plugins" directory. Within this directory one can place plugins in
54
subdirectories. For example, "plugins/bzrtools/".
53
system-wide or on a per user basis. Both methods involve creating a
54
``plugins`` directory. Within this directory one can place plugins in
55
subdirectories. For example, ``plugins/bzrtools/``.
56
Two locations are currently checked; the bzrlib/plugins directory
57
(typically found in /usr/lib/python2.4/site-packages/bzrlib/plugins/) and
58
$HOME/.bazaar/plugins/.
57
Two locations are currently checked: the bzrlib/plugins directory
58
(typically found in ``/usr/lib/python2.4/site-packages/bzrlib/plugins/``) and
59
``$HOME/.bazaar/plugins/``.
60
61
One can additionally override the home plugins by setting the environment
61
variable BZR_PLUGIN_PATH to a directory that contains plugins. The
62
installation of a plugin can be checked by running **bzr plugins** at
63
any time. New commands can be seen by running **bzr help commands**.
62
variable ``BZR_PLUGIN_PATH`` to a directory that contains plugins. The
63
installation of a plugin can be checked by running ``bzr plugins`` at
64
any time. New commands can be seen by running ``bzr help commands``.
65
66
Plugins work particularly well with Bazaar branches. For example, to
66
67
install the bzrtools plugins for your main user account, one can perform
added
removed
doc/plugins.txt
