| 17 | | If you have downloaded a source distribution of a plugin, and want to build the `.egg` file: |
| 18 | | |
| 19 | | * Unpack the source. It should provide `setup.py`. |
| 20 | | * Run: |
| | 17 | Packages built for a single project must use the egg |
| | 18 | format, as the wheel format (described below) is not |
| | 19 | supported by the setuptools loading mechanism. Build the `egg` file from the plugin source: |
| | 20 | |
| | 21 | * Checkout or download and unpack the source. |
| | 22 | * Change to the directory containing `setup.py`. |
| | 23 | * Run: |
| 24 | | |
| 25 | | You should now have an *.egg file. Examine the output of running Python to find where this was created. |
| 26 | | |
| 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. |
| 28 | | |
| 29 | | To uninstall a plugin installed this way, remove the egg from the `plugins` directory and restart the web server. |
| 30 | | |
| 31 | | '''Note''': the Python version that the egg is built with ''must'' match the Python version with which Trac is run. For example, if you are running Trac under Python 2.6, but have upgraded your standalone Python to 2.7, the eggs won't be recognized. |
| 32 | | |
| 33 | | '''Note''': in a multi-project setup, a pool of Python interpreter instances will be dynamically allocated to projects based on need; 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 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. |
| | 27 | The egg file will be created in the `dist` subdirectory. |
| | 28 | * Copy the egg file to the `plugins` directory of the [TracEnvironment project environment]. |
| | 29 | |
| | 30 | Make sure the web server has sufficient permissions to read the plugin egg and restart the web server. If you are running as a [TracStandalone "tracd" standalone server], restart tracd (i.e. kill the process and run again). |
| | 31 | |
| | 32 | Trac also searches for plugins installed in the [TracIni#GlobalConfiguration global shared] plugins directory. This is a convenient way to share the installation of plugins across several, but not all, environments. |
| | 33 | |
| | 34 | '''Note''': The minor version number of the Python used to build the egg ''must'' match the minor version number of the Python running Trac. For example, if you are running Trac with Python 2.6, but build the egg with Python 2.7, the egg won't be recognized. |
| | 35 | |
| | 36 | '''Note''': In a multi-project setup, a pool of Python interpreters will be dynamically allocated to projects based on need. 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 projects. In other words, you cannot use different versions of a plugin in different projects of a multi-project setup. Install plugins for all projects (see below) and enable them as needed for each project. |
| | 37 | |
| | 38 | ==== Uninstalling #UninstallEgg |
| | 39 | |
| | 40 | Remove the egg from the `plugins` directory and restart the web server. |
| 37 | | ==== With an .egg file |
| 38 | | |
| 39 | | Some plugins, such as [https://trac-hacks.org/wiki/TagsPlugin TracTags], are downloadable as an `.egg` file that can be installed with `easy_install` or `pip`: |
| 40 | | {{{#!sh |
| 41 | | $ easy_install TracTags |
| 42 | | }}} |
| | 44 | ==== Using pip |
| | 45 | |
| | 46 | The modern Python package manager, `pip`, is included in Python 2.7.9 and later. In earlier versions of Python it can be installed through the package manager of your OS (e.g. `apt-get install python-pip`) or using [https://pip.pypa.io/en/latest/installing.html#install-pip get_pip.py]. |
| | 47 | |
| | 48 | Using `pip`, the plugin will be installed |
| | 49 | in the [https://pythonwheels.com/ wheel format], which is the modern standard for Python and a |
| | 50 | replacement for the egg format. |
| | 51 | |
| | 52 | ==== From PyPI |
| | 53 | |
| | 54 | Some plugins, such as [th:TagsPlugin TracTags], can be installed directly from [https://pypi.org PyPI] using `pip`: |
| 47 | | If `easy_install` is not on your system, see the [trac:setuptools#Installsetuptools Trac setuptools documentation]. |
| 48 | | |
| 49 | | `pip` is included in Python 2.7.9. In earlier versions of Python it can be installed through the package manager of your OS (e.g. `apt-get install python-pip`) or using the [https://pip.pypa.io/en/latest/installing.html#install-pip get_pip.py]. |
| 50 | | |
| 51 | | If Trac reports permission errors after installing a zipped egg, and you would rather not bother providing an 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`: |
| 52 | | {{{#!sh |
| 53 | | $ easy_install --always-unzip TracTags |
| 54 | | }}} |
| 55 | | You should end up with a directory having the same name as the zipped egg, complete with `.egg` extension, and containing its uncompressed contents. |
| 56 | | |
| 57 | | Trac also searches for plugins installed in the shared plugins directory, see TracIni#GlobalConfiguration. This is a convenient way to share the installation of plugins across several, but not all, environments. |
| | 59 | The version can be specified, which can be useful if you don't want to install the latest: |
| | 60 | {{{#!sh |
| | 61 | $ pip install TracTags==0.10 |
| | 62 | }}} |
| 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 | | |
| 125 | | ==== Uninstalling |
| 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 | | |
| 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: |
| 135 | | |
| 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. |
| 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`. |
| 138 | | 1. Delete the .egg file or folder from where it's installed, usually inside `$PYTHONLIB/site-packages/`. |
| 139 | | 1. Restart the web server. |
| 140 | | |
| 141 | | If you are uncertain about the location of the egg file, you can try to locate it by replacing `myplugin` with whatever namespace the plugin uses (as used when enabling the plugin): |
| 142 | | {{{#!pycon |
| 143 | | >>> import myplugin |
| 144 | | >>> print myplugin.__file__ |
| 145 | | /opt/local/python24/lib/site-packages/myplugin-0.4.2-py2.4.egg/myplugin/__init__.pyc |
| 146 | | }}} |
| 147 | | |
| 148 | | == Setting up the plugin cache |
| 149 | | |
| 150 | | Some plugins will need to be extracted by the Python egg's runtime. See [wiki:TracInstall#egg-cache] for information on setting up the egg cache. |
| | 130 | ==== Uninstalling #UninstallWithPip |
| | 131 | |
| | 132 | Get a list of installed plugins: |
| | 133 | {{{#!sh |
| | 134 | $ pip list |
| | 135 | Package Version |
| | 136 | ---------- ------- |
| | 137 | Jinja2 2.10.1 |
| | 138 | MarkupSafe 1.1.1 |
| | 139 | pip 19.2.2 |
| | 140 | setuptools 41.2.0 |
| | 141 | Trac 1.4 |
| | 142 | TracTags 0.10 |
| | 143 | wheel 0.33.6 |
| | 144 | }}} |
| | 145 | |
| | 146 | Uninstall a plugin by specifying the package name: |
| | 147 | {{{#!sh |
| | 148 | $ pip uninstall TracTags |
| | 149 | }}} |
| 164 | | This disables the whole panel, so the first function will no longer be available either. |
| | 163 | This disables the whole panel, so the first function will no longer be available. |
| | 164 | |
| | 165 | == Setting up the plugin cache |
| | 166 | |
| | 167 | Some plugins installed as eggs will need to be extracted by the Python egg's runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory to 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. |
| | 168 | |
| | 169 | To do this from the Apache configuration, use the `SetEnv` directive: |
| | 170 | {{{#!apache |
| | 171 | SetEnv PYTHON_EGG_CACHE /path/to/dir |
| | 172 | }}} |
| | 173 | |
| | 174 | 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], i.e. in the same `<Location>` block. |
| | 175 | |
| | 176 | For example for CGI: |
| | 177 | {{{#!apache |
| | 178 | <Location /trac> |
| | 179 | SetEnv TRAC_ENV /path/to/projenv |
| | 180 | SetEnv PYTHON_EGG_CACHE /path/to/dir |
| | 181 | </Location> |
| | 182 | }}} |
| | 183 | |
| | 184 | Or for mod_python: |
| | 185 | {{{#!apache |
| | 186 | <Location /trac> |
| | 187 | SetHandler mod_python |
| | 188 | ... |
| | 189 | SetEnv PYTHON_EGG_CACHE /path/to/dir |
| | 190 | </Location> |
| | 191 | }}} |
| | 192 | |
| | 193 | '''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. |
| | 194 | |
| | 195 | For [TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables. |
| | 196 | |
| | 197 | '''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: |
| | 198 | |
| | 199 | {{{#!apache |
| | 200 | FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache |
| | 201 | }}} |
| | 202 | |
| | 203 | === About hook scripts |
| | 204 | |
| | 205 | If you have Subversion hook scripts that invoke Trac, such as the post-commit hook script provided in the `/contrib` directory, make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts. |
| | 206 | |
| | 207 | == Writing Trac Plugins |
| | 208 | |
| | 209 | You can write your own Trac plugin using the following resources: |
| | 210 | * [trac:TracDev Developer documentation] |
| | 211 | * [https://trac-hacks.org Examples on trac-hacks.org] |
| | 212 | * [trac:browser:branches/1.4-stable/sample-plugins sample-plugins] |
| 189 | | * the value is "enabled", not "enable" or "Enable". |
| 190 | | * the section name is "components", not "component". |
| 191 | | |
| 192 | | === Check the permissions on the .egg file |
| 193 | | |
| 194 | | Trac must be able to read the .egg file. |
| | 228 | * the value is `enabled`, not `enable` or `Enable`. |
| | 229 | * the section name is `components`, not `component`. |
| | 230 | |
| | 231 | === Check the permissions |
| | 232 | |
| | 233 | Trac must be able to read the .py file or package (.egg or .whl). |
| 206 | | 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: |
| 207 | | |
| 208 | | * 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. |
| 209 | | * A globally installed plugin (typically `setup.py install`) will override any version in the global or project plugins directories. A plugin from the global plugins directory will be located ''before'' any project plugins directory. |
| 210 | | * If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), having two versions of a plugin in two different projects will give unpredicatable results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first plugin found, usually from the project that receives the first request. |
| 211 | | * Having more than one version listed inside Python site-packages is fine, ie installed with `setup.py install`, because setuptools will make sure you get the version installed most recently. However, don't store more than one version inside a global or project plugins directory: neither the version number nor the installed date will matter at all. There is no way to determine which one will be located first when Trac searches the directory for plugins. |
| | 245 | If you put your plugins in one of 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: |
| | 246 | |
| | 247 | * Only one version of the plugin can be loaded for each running Trac server, i.e. 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. |
| | 248 | * A globally installed plugin will override any version in the global or project plugins directories. A plugin from the global plugins directory will be discovered ''before'' any project plugins directory. |
| | 249 | * If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), having two versions of a plugin in two different projects will give unpredicatable results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first plugin found, usually from the project that receives the first request. |
| | 250 | * Having more than one version listed inside Python site-packages is fine, because setuptools will make sure you get the version installed most recently. However, don't store more than one version inside a global or project plugins directory: neither the version number nor the installed date will matter at all. There is no way to determine which one will be located first when Trac searches the directory for plugins. |
