| 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 single .py file or a package (.egg or .whl). Trac looks for plugins in Python's `site-packages` directory, the [TracIni#GlobalConfiguration global shared] `plugins` directory and the [TracEnvironment project environment] `plugins` directory. Plugins installed to the project environment `plugins` directory are enabled, unless explicitly disabled in the `[components]` section of the `trac.ini` file. Plugins installed elsewhere must be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the `trac.ini` file. |
| 31 | | If you have downloaded a source distribution of a plugin, and want to build the `.egg` file: |
| 32 | | |
| 33 | | * Unpack the source. It should provide `setup.py`. |
| 34 | | * 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 setuptool 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: |
| 38 | | |
| 39 | | You should now have an *.egg file. Examine the output of running Python to find where this was created. |
| 40 | | |
| 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. |
| 42 | | |
| 43 | | To uninstall a plugin installed this way, remove the egg from the `plugins` directory and restart the web server. |
| 44 | | |
| 45 | | '''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. |
| | 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 shared plugins directory, see TracIni#GlobalConfiguration. 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. |
| 51 | | ==== With an .egg file |
| 52 | | |
| 53 | | 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`: |
| 54 | | {{{#!sh |
| 55 | | $ easy_install TracTags |
| | 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`: |
| | 55 | {{{#!sh |
| 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:\Python27\Scripts`) to their `PATH` environment variable, or use the full path to `easy_install` (for example, `C:\Python27\Scripts\easy_install.py`). See [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information. |
| 60 | | |
| 61 | | `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]. |
| 62 | | |
| 63 | | 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`: |
| 64 | | {{{#!sh |
| 65 | | $ easy_install --always-unzip TracTags |
| 66 | | }}} |
| 67 | | You should end up with a directory having the same name as the zipped egg, complete with `.egg` extension, and containing its uncompressed contents. |
| 68 | | |
| 69 | | 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.9 |
| | 62 | }}} |
| 73 | | `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: |
| 74 | | {{{#!sh |
| 75 | | $ easy_install https://trac-hacks.org/svn/tagsplugin/trunk |
| | 66 | You can install directly from a source repository: |
| | 67 | {{{#!sh |
| | 68 | $ pip install svn+https://trac-hacks.org/svn/tagsplugin/trunk |
| | 69 | }}} |
| | 70 | |
| | 71 | Replace the `svn+` prefix with `git+` if installing |
| | 72 | from a Git repository. |
| | 73 | |
| | 74 | Or from the path or URL of a tar.gz or zip archive: |
| | 75 | {{{#!sh |
| | 76 | $ pip install https://trac-hacks.org/browser/tagsplugin/trunk?format=zip |
| | 77 | }}} |
| | 78 | |
| | 79 | Or checkout the source and provide `pip` a path to the source directory: |
| | 80 | {{{#!sh |
| | 81 | $ svn co https://trac-hacks.org/svn/tagsplugin/trunk tractags |
| | 82 | $ pip install tractags |
| 123 | | 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 | | |
| 125 | | 1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools. |
| 126 | | 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 | | 1. Delete the .egg file or folder from where it's installed, usually inside `$PYTHONLIB/site-packages/`. |
| 128 | | 1. Restart the web server. |
| 129 | | |
| 130 | | 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): |
| 131 | | {{{#!pycon |
| 132 | | >>> import myplugin |
| 133 | | >>> print myplugin.__file__ |
| 134 | | /opt/local/python24/lib/site-packages/myplugin-0.4.2-py2.4.egg/myplugin/__init__.pyc |
| 135 | | }}} |
| | 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 | }}} |
| | 150 | |
| | 151 | == Web-based plugin administration |
| | 152 | |
| | 153 | The !WebAdmin interface offers limited support for plugin configuration through the web to users with `TRAC_ADMIN` permission: |
| | 154 | |
| | 155 | * en/disabling installed plugins |
| | 156 | * installing plugins by uploading them as eggs |
| | 157 | |
| | 158 | If you wish to disable the second function for security reasons, add the following to your `trac.ini` file: |
| | 159 | {{{#!ini |
| | 160 | [components] |
| | 161 | trac.admin.web_ui.PluginAdminPanel = disabled |
| | 162 | }}} |
| | 163 | This disables the whole panel, so the first function will no longer be available. |
| 179 | | == Web-based plugin administration |
| 180 | | |
| 181 | | The !WebAdmin interface offers limited support for plugin configuration through the web to users with `TRAC_ADMIN` permission: |
| 182 | | |
| 183 | | * en/disabling installed plugins |
| 184 | | * installing plugins by uploading them as eggs |
| 185 | | |
| 186 | | If you wish to disable the second function for security reasons, add the following to your `trac.ini` file: |
| 187 | | {{{#!ini |
| 188 | | [components] |
| 189 | | trac.admin.web_ui.PluginAdminPanel = disabled |
| 190 | | }}} |
| 191 | | This disables the whole panel, so the first function will no longer be available either. |
| 192 | | |
| 242 | | * 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. |
| 243 | | * 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. |
| 244 | | * 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. |
| 245 | | * 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. |
| | 247 | * 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. |
| | 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. |
