Changes between Version 1 and Version 2 of TracPlugins
- Timestamp:
- Apr 13, 2011, 9:02:13 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracPlugins
v1 v2 2 2 [[TracGuideToc]] 3 3 4 Since version 0.9, Trac supports [trac:PluginList plugins] that extend the built-in functionality. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture].4 Trac is extensible with [trac:PluginList plugins] since version 0.9. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture] with peculiarities described at [TracDev/PluginDevelopment plugin development] page. 5 5 6 == Requirements == 6 == Plugin discovery == 7 8 From the user point of view a Plugin is either standalone .py file or an .egg package. Trac looks for Plugins in a global shared plugins directory (see [TracIni#GlobalConfiguration Global Configuration]) and in `plugins` directory of local TracEnvironment. Components defined in globally installed plugins should be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the trac.ini file. 9 10 == Requirements for Trac eggs == 7 11 8 12 To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed. … … 15 19 If 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. 16 20 17 Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''. See TracIni#GlobalConfiguration.21 Plugins can also consist of a single `.py` file dropped directly into the root of environment's or into shared `plugins` directory. 18 22 19 23 == Installing a Trac Plugin == … … 32 36 Then you will have a *.egg file. Examine the output of running python to find where this was created. 33 37 34 Once 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. 38 Once 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. Then, restart the web server (this requirement was not previously mentioned in this document, but in my tests it began working only after I did so). 35 39 36 40 To uninstall a plugin installed this way, remove the egg from `plugins` directory and restart web server. … … 38 42 Note that the Python version that the egg is built with must 39 43 match the Python version with which Trac is run. If for 40 instance you are running Trac under Python 2. 3, but have41 upgraded your standalone Python to 2. 4, the eggs won't be44 instance you are running Trac under Python 2.5, but have 45 upgraded your standalone Python to 2.6, the eggs won't be 42 46 recognized. 43 47 … … 53 57 }}} 54 58 55 If `easy_install` is not on your system see the Requirements section above to install it. Windows users will need to add the `Scripts` directory of their Python installation (for example, `C:\Python2 3\Scripts`) to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information).59 If `easy_install` is not on your system see the Requirements section above to install it. Windows users will need to add the `Scripts` directory of their Python installation (for example, `C:\Python24\Scripts`) to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information). 56 60 57 61 If Trac reports permission errors after installing a zipped egg and you would rather not bother providing a egg cache directory writable by the web server, you can get around it by simply unzipping the egg. Just pass `--always-unzip` to `easy_install`: 58 62 {{{ 59 easy_install --always-unzip TracSpamFilter-0. 2.1dev_r5943-py2.4.egg63 easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg 60 64 }}} 61 65 You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents. 62 66 63 Trac also searches for globally installed plugins ''(since 0.10)'', see TracIni#GlobalConfiguration.67 Trac also searches for plugins installed in the shared plugins directory ''(since 0.10)'', see TracIni#GlobalConfiguration. This is a convenient way to share the installation of plugins across several but not all environments. 64 68 65 69 ==== From source ==== … … 67 71 `easy_install` makes installing from source a snap. Just give it the URL to either a Subversion repository or a tarball/zip of the source: 68 72 {{{ 69 easy_install http://svn.edgewall.com/repos/trac/ sandbox/spam-filter73 easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha 70 74 }}} 71 75 72 76 ==== Enabling the plugin ==== 73 Unlike plugins installed per-environment, you'll have to explicitly enable globally installed plugins via [wiki:TracIni trac.ini]. This also applies to plugins installed in the path specified in the `[inherit] plugins_dir` configuration option. This is done in the `[components]` section of the configuration file, for example: 77 Unlike plugins installed per-environment, you'll have to explicitly enable globally installed plugins via [wiki:TracIni trac.ini]. This also applies to plugins installed in shared plugins directory, i.e. the path specified in the `[inherit] plugins_dir` configuration option. 78 79 This is done in the `[components]` section of the configuration file, for example: 74 80 {{{ 75 81 [components] … … 98 104 == Setting up the Plugin Cache == 99 105 100 Some plugins will need to be extracted by the Python eggs runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory in which they are extracted defaults to the home directory of the current user, which may or may not be a problem. You can however override the default location using the `PYTHON_EGG_CACHE` environment variable.106 Some plugins will need to be extracted by the Python eggs runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory in which they are extracted defaults to '.python-eggs' in the home directory of the current user, which may or may not be a problem. You can however override the default location using the `PYTHON_EGG_CACHE` environment variable. 101 107 102 108 To do this from the Apache configuration, use the `SetEnv` directive as follows: … … 151 157 === Did you get the correct version of the Python egg? === 152 158 153 Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2. 4.egg` is an egg for Python 2.4, and will '''not''' be loaded if you're running a different Python version (such as 2.3 or 2.5).159 Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.5.egg` is an egg for Python 2.5, and will '''not''' be loaded if you're running a different Python version (such as 2.4 or 2.6). 154 160 155 161 Also, verify that the egg file you downloaded is indeed a ZIP archive. If you downloaded it from a Trac site, chances are you downloaded the HTML preview page instead.
