Python Plugin Installer

Downloads and installs plugins from remote repositories.

Plugins tab
Repositories tab
Options tab

Plugins tab

The Plugins tab contains a list of all locally installed Python plugins, as well as plugins available in remote repositories. Each plugin can be either:

not installed: this means the plugin is available in the repository, but is not installed yet. In order to install it, select the plugin from the list and click the Install plugin button.
new: this means that the plugin is newly available in the repository.
installed: this indicates that the plugin is already installed. If it is also available in any repository the Reinstall plugin button will be enabled. If the available version is older than the installed version, the Downgrade plugin button will appear instead.
upgradeable: this means that the plugin is installed, but there is an updated version available. In this case, the Upgrade plugin button will be enabled.
invalid: this means that the plugin is installed, but is unavailable or broken. The reason will be explained in the plugin description ﬁeld.

To install a plugin, select it from the list and click the Install plugin button. The plugin is installed in its own directory in:

OS	system plugins	plugins installed by user
Linux and other unices	./share/qgis/python/plugins	$HOME/qgis/python/plugins
Mac OS X	./Contents/MacOS/share/qgis/python/plugins	$HOME/qgis/python/plugins
Windows	(QGIS install directory)\python\plugins	%USERPROFILE%\.qgis\python\plugins

If the installation is successful, a conﬁrmation message will appear. The plugin is ready to use.

If the installation fails, the reason for the failure will be displayed in a warning dialog. Most often, errors are the result of connection problems and/or missing Python modules. In the former case you will likely need to wait before trying the install again, in the latter case, you should install the missing modules relevant to your operating system prior to using the plugin. For Linux, most required modules should be available via a package manager. For install instructions in Windows visit the module home page. If you are using a proxy, you may need to conﬁgure it under Edit > Options (Gnome, OSX) or Settings > Options (KDE, Windows) on the Proxy tab.

The Uninstall plugin button is enabled only if the selected plugin is installed and is not a core plugin. Note that if you have installed an update to a core plugin, you can uninstall this update with the Uninstall plugin and revert to the version shipped with Quantum GIS. This default version however, cannot be uninstalled.

Repositories tab

The second tab Repositories, contains a list of plugin repositories available for the Plugin Installer. By default, only the QGIS Ofﬁcial Repository is enabled. You can add several user-contributed repositories, including the central QGIS Contributed Repository and other external repositories by clicking the Add 3rd party repositories button. The added repositories contain a large number of useful plugins which are not maintained by the QGIS Development Team. As such, we cannot take any responsibility for them. You can also manage the repository list manually, that is add, remove, and edit the entries. Temporarily disabling a particular repository is possible by clicking the Edit... button.

Options tab

The Options tab is where you can conﬁgure the settings of the Plugin Installer. The x Check for updates on start up check box tells QGIS to automatically look for plugin updates and news. By default, if this feature is enabled all repositories listed and enabled in the Repositories tab are checked for updates each time the program is started. The frequency of update checking can be adjusted using the drop down menu, and may be adjusted from once a day right up to once a month. If a new plugin or update is available for one of the installed plugins, a notiﬁcation will appear in the Status Bar. If the check box is disabled, looking for updates and news is performed only when the Plugin Installer is manually launched from the menu.

Some Internet connections will cause problems when attempting to automatically check for updates. In these cases, a Looking for new plugins... indicator will remain visible in the Status Bar during your entire QGIS session, and may cause a program crash when exiting. In this case please disable the check box.

In addition, you may specify the type of plugins that are displayed by the Plugin Installer. Under Allowed plugins, you can specify whether you would like to:

Only show plugins from the ofﬁcial repository
Show all plugins except those marked as experimental,
or Show all plugins, even those marked as experimental.

Note: Experimental plugins are generally unsuitable for production use. These plugins are in the early stages of development, and should be considered "incomplete" or "proof of concept" tools. The QGIS development team does not recommend installing these plugins unless you intend to use them for testing purposes.