Changes between Version 3 and Version 4 of TracPlugins


Ignore:
Timestamp:
May 30, 2008 2:26:53 PM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v3 v4  
    22[[TracGuideToc]]
    33
    4 Since version 0.9, Trac supports plugins that extend the built-in functionality. The plugin functionality is based on the [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture component architecture].
     4Since version 0.9, Trac supports [PluginList plugins] that extend the built-in functionality. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture].
    55
    66== Requirements ==
     
    1515If the `ez_setup.py` script fails to install the setuptools release, you can download it from [http://www.python.org/pypi/setuptools PyPI] and install it manually.
    1616
    17 Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''.
     17Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''. See TracIni#GlobalConfiguration .
    1818
    1919== Installing a Trac Plugin ==
     
    3434Once you have the plugin archive, you need to copy it into the `plugins` directory of the [wiki:TracEnvironment project environment]. Also, make sure that the web server has sufficient permissions to read the plugin egg.
    3535
     36To uninstall a plugin installed this way, remove the egg from `plugins` directory and restart web server.
     37
    3638Note that the Python version that the egg is built with must
    3739match the Python version with which Trac is run.  If for
     
    4042recognized.
    4143
     44Note also that in a multi-project setup, a pool of Python interpreter instances will be dynamically allocated to projects based on need, and since plugins occupy a place in Python's module system, the first version of any given plugin to be loaded will be used for all the projects. In other words, you cannot use different versions of a single plugin in two projects of a multi-project setup. It may be safer to install plugins for all projects (see below) and then enable them selectively on a project-by-project basis.
     45
    4246=== For All Projects ===
    4347
    4448==== With an .egg file ====
    4549
    46 Some plugins (such as [http://trac.edgewall.org/wiki/SpamFilter SpamFilter]) are downloadable as a `.egg` file which can be installed with the `easy_install` program:
     50Some plugins (such as [trac:SpamFilter SpamFilter]) are downloadable as a `.egg` file which can be installed with the `easy_install` program:
    4751{{{
    4852easy_install TracSpamFilter
     
    5761You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents.
    5862
    59 Trac also searches for globally installed plugins under `$PREFIX/share/trac/plugins` ''(since 0.10)''.
     63Trac also searches for globally installed plugins ''(since 0.10)'', see TracIni#GlobalConfiguration.
    6064
    6165==== From source ====
     
    7680
    7781Note: After installing the plugin, you need to restart your web server.
     82
     83==== Uninstalling ====
     84
     85`easy_install` or `python setup.py` does not have an uninstall feature. Hower, it is usually quite trivial to remove a globally installed egg and reference:
     86 1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools.
     87 1. Delete executables from `/usr/bin`, `/usr/local/bin` or `C:\\Python*\Scripts`. For search what executables are there, you may refer to `[console-script]` section of `setup.py`.
     88 1. Delete the .egg file or folder from where it is installed, usually inside `$PYTHONLIB/site-packages/`.
     89 1. Restart web server.
     90
     91If you are uncertain about the location of the egg, here is a small tip to help locate an egg (or any package) - replace `myplugin` with whatever namespace the plugin uses (as used when enabling the plugin):
     92{{{
     93>>> import myplugin
     94>>> print myplugin.__file__
     95/opt/local/python24/lib/site-packages/myplugin-0.4.2-py2.4.egg/myplugin/__init__.pyc
     96}}}
    7897
    7998== Setting up the Plugin Cache ==
     
    153172=== Is the wrong version of the plugin loading? ===
    154173
    155 If you put your plugins inside plugins directories, and certainly if you have more than one project, you need to make sure that the correct version of the plugin is loading. Here are som basic rules:
     174If you put your plugins inside plugins directories, and certainly if you have more than one project, you need to make sure that the correct version of the plugin is loading. Here are some basic rules:
    156175 * Only one version of the plugin can be loaded for each running Trac server (ie. each Python process). The Python namespaces and module list will be shared, and it cannot handle duplicates. Whether a plugin is `enabled` or `disabled` makes no difference.
    157176 * A globally installed plugin (typically `setup.py install`) will override any version in global or project plugins directories. A plugin from the global plugins directory will be located before any project plugins directory.
     
    164183
    165184----
    166 See also TracGuide, [http://trac.edgewall.org/wiki/PluginList plugin list], [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture component architecture]
     185See also TracGuide, [trac:PluginList plugin list], [trac:TracDev/ComponentArchitecture component architecture]