Changes between Version 93 and Version 94 of TracPlugins
- Timestamp:
- Apr 2, 2017, 1:07:35 AM (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracPlugins
v93 v94 7 7 == Plugin discovery 8 8 9 From the user's point of view, a plugin is either a standalone .py file or an .egg package. Trac looks for plugins in Python's `site-packages` directory, the [TracIni#GlobalConfiguration global shared] `plugins` directory and the [TracEnvironment project environment] `plugins` directory. Components defined in globally-installed plugins must be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the `trac.ini` file. Components defined in the `plugins` directory of the project environment are enabled, unless explicitly disabled in the `[components]` section of the `trac.ini` file. 10 11 == Requirements for Trac eggs #Requirements 12 13 To use egg-based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version >= 0.6) installed. 14 15 To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows: 16 17 {{{#!sh 18 $ python ez_setup.py 19 }}} 20 21 If the `ez_setup.py` script fails to install the setuptools release, you can download it from [pypi:setuptools PyPI] and install it manually. 22 23 Plugins can also consist of a single `.py` file dropped directly into either the project's or the shared `plugins` directory. 9 From the user's point of view, a plugin is either a standalone .py file or a package (egg or wheel). Trac looks for plugins in Python's `site-packages` directory, the [TracIni#GlobalConfiguration global shared] `plugins` directory and the [TracEnvironment project environment] `plugins` directory. Components defined in globally-installed plugins must be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the `trac.ini` file. Components defined in the `plugins` directory of the project environment are enabled, unless explicitly disabled in the `[components]` section of the `trac.ini` file. 24 10 25 11 == Installing a Trac plugin … … 39 25 You should now have an *.egg file. Examine the output of running Python to find where this was created. 40 26 41 Once you have the plugin archive, 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. If you are running as a [wiki:TracStandalone "tracd" standalone server], restart tracd, ie kill the process and run again.27 Once you have the plugin archive, copy it into the `plugins` directory of the [TracEnvironment project environment]. Also, make sure that the web server has sufficient permissions to read the plugin egg. Then restart the web server. If you are running as a [TracStandalone "tracd" standalone server], restart tracd, ie kill the process and run again. 42 28 43 29 To uninstall a plugin installed this way, remove the egg from the `plugins` directory and restart the web server. … … 54 40 {{{#!sh 55 41 $ easy_install TracTags 42 }}} 43 {{{#!sh 56 44 $ pip install TracTags 57 45 }}} … … 71 59 ==== From source 72 60 73 `easy_install` makes installing from source a snap. Just give it the URL to either a Subversionrepository or a tarball/zip of the source:61 `easy_install` and `pip` make installing from source a snap. Just give it the URL to either a repository or a tarball/zip of the source: 74 62 {{{#!sh 75 63 $ easy_install https://trac-hacks.org/svn/tagsplugin/trunk 76 64 }}} 65 {{{#!sh 66 $ pip install svn+https://trac-hacks.org/svn/tagsplugin/trunk 67 }}} 68 When installing from a repository using `pip`, be sure to use the repository type in the protocol. For example, `svn+https` for Subversion and `git+https` for Git. 77 69 78 70 ==== Enabling the plugin 79 71 80 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 shared plugins directory, ie the path specified in the `[inherit] plugins_dir`configuration option.81 82 This is done in the `[components]`section of the configuration file `trac.ini`. For example:72 Unlike plugins installed per environment, you'll have to explicitly enable globally installed plugins via [TracIni trac.ini]. This also applies to plugins installed in the shared plugins directory, ie the path specified in the [TracIni#inherit-plugins_dir-option "[inherit] plugins_dir"] configuration option. 73 74 This is done in the [TracIni#components-section "[components]"] section of the configuration file `trac.ini`. For example: 83 75 {{{#!ini 84 76 [components] … … 119 111 }}} 120 112 113 ==== Upgrading a Plugin 114 115 Normally, upgrading a plugin is simply a matter of repeating the install process. You may want to [#Uninstalling uninstall] old versions of the plugin. 116 117 The `pip install` command has an `--upgrade (-U)` switch that will uninstall the old version and install the new version. The command can have some unintended side-effects though, because it will also upgrade the plugin dependencies. For example, if `Trac` is listed as a dependency of the plugin in `setup.py`, the latest version of Trac will be downloaded and installed. This may not be what you want if you are running an older version of Trac because not all your plugins are compatible with the latest version of Trac, or you simply haven't done the appropriate planning for upgrading Trac. Uninstalling and then installing the plugin can be a safer option: 118 {{{#!sh 119 $ pip uninstall <pluginname> 120 $ pip install <pluginname> 121 }}} 122 123 Alternatively you can use a [https://pip.pypa.io/en/stable/user_guide/#requirements-files requirements file] and pin the versions of the packages that you don't want to implicitly upgrade. 124 121 125 ==== Uninstalling 122 126 127 `pip` makes it easy to uninstall a plugin: 128 {{{#!sh 129 $ pip uninstall <pluginname> 130 }}} 131 132 The `pip uninstall` command can be used even if the plugin was installed using `easy_install` or `python setup.py install`. 133 123 134 Neither `easy_install` nor `python setup.py` have an uninstall feature. However, it is usually trivial to remove a globally installed egg and reference: 124 135 125 1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugininstalled by setuptools.136 1. Do `easy_install -m <plugin name>` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin is installed by setuptools. 126 137 1. Delete executables from `/usr/bin`, `/usr/local/bin`, or `C:\\Python*\Scripts`. To find what executables are involved, refer to the `[console-script]` section of `setup.py`. 127 138 1. Delete the .egg file or folder from where it's installed, usually inside `$PYTHONLIB/site-packages/`. … … 144 155 }}} 145 156 146 This works whether you're using the [ wiki:TracCgi CGI] or the [wiki:TracModPython mod_python] front-end. Put this directive next to where you set the path to the [wiki:TracEnvironment Trac environment], ie in the same `<Location>` block.147 148 For example for CGI:157 This works whether you're using the [TracCgi CGI] or the [TracModPython mod_python] front-end. Put this directive next to where you set the path to the [TracEnvironment Trac environment], ie in the same `<Location>` block. 158 159 Example for CGI: 149 160 {{{#!apache 150 161 <Location /trac> … … 165 176 '''Note''': !SetEnv requires the `mod_env` module, which needs to be activated for Apache. In this case the !SetEnv directive can also be used in the `mod_python` Location block. 166 177 167 For [ wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.178 For [TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables. 168 179 169 180 '''Note''': if you already use -initial-env to set the project directory for either a single project or parent, you will need to add an additional -initial-env directive to the !FastCgiConfig directive: … … 179 190 == Web-based plugin administration 180 191 181 The [trac:WebAdmin] interface offers limited support for plugin configuration t hrough the web to users with `TRAC_ADMIN` permission:182 183 * en /disabling installed plugins192 The [trac:WebAdmin] interface offers limited support for plugin configuration to users with `TRAC_ADMIN` permission: 193 194 * enabling and disabling installed plugins 184 195 * installing plugins by uploading them as eggs 185 196 … … 223 234 === Check the log files 224 235 225 Enable [ wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins.236 Enable [TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins. 226 237 227 238 === Verify you have the proper permissions … … 231 242 === Is the wrong version of the plugin loading? 232 243 233 If you put your plugins inside pluginsdirectories, 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:244 If you put your plugins inside the `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: 234 245 235 246 * 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. … … 240 251 === If all of the above failed 241 252 242 Okay, so the logs don't mention plugins, the egg is readable, the Python version is correct, ''and'' the egg has been installed globally (and is enabled in trac.ini)... and it ''still'' doesn't work or give any error messages or any other indication as to why. Hop on the [trac:IrcChannel IrcChannel] and ask away!253 Okay, so the logs don't mention plugins, the egg is readable, the Python version is correct, ''and'' the egg has been installed globally (and is enabled in trac.ini)... and it ''still'' doesn't work or give any error messages or any other indication as to why. Hop on the [trac:IrcChannel IrcChannel] or [trac:MailingList] and ask away! 243 254 244 255 ----