PyCharm 2019.2 Help

Managing plugins

Plugins extend the core functionality of PyCharm:

  • Provide integration with version control systems, application servers, and other tools

  • Add coding assistance support for various languages and frameworks

  • Boost your productivity with shortcut hints, live previews, file watchers, and so on

  • Help you learn a new programming language with coding exercises and verification

Open plugin settings

  • In the Settings/Preferences dialog (Ctrl+Alt+S), select Plugins.

The Plugins settings dialog

On the Plugins page, you can do the following:

  • Use the Marketplace tab to browse and install plugins from the JetBrains Plugin Repository or from a custom plugin repository.

  • Use the Installed tab to browse installed plugins, enable, disable, update, or remove them. Disabling unnecessary plugins can increase performance.

Most plugins can be used with any JetBrains product. Some are limited only to commercial products. There are also plugins that require a separate license.

If a plugin depends on some other plugin, PyCharm will notify you about the dependencies. If your project depends on certain plugins, add them to the list of required plugins.

If some functionality is not covered by existing plugins, you can create your own plugin for PyCharm. For information, see Managing plugins.

By default, PyCharm includes a number of bundled plugins. You can disable bundled plugins, but they cannot be removed. You can install additional plugins from the plugin repository or from a local archive file (ZIP or JAR).

Install plugin from repository

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Plugins.

  2. Find the plugin in the Marketplace and click Install.

Install plugin from disk

After you download the plugin archive (ZIP or JAR), do the following:

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Plugins.

  2. On the Plugins page, click The Settings button and then click Install Plugin from Disk.

  3. Select the plugin archive file and click OK.

  4. Click OK to apply the changes and restart the IDE if prompted.

Remove plugin

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Plugins.

  2. Open the Installed tab and find the plugin that you want to remove.

  3. Click The down arrow next to the Disable/Enable button and select Uninstall from the dropdown menu.

The Uninstall item for plugins

Custom plugin repositories

By default, PyCharm is configured to use plugins from the JetBrains Plugin Repository. This is where all the community plugins are hosted, and you are free to host your plugins there. However, if you develop plugins for internal use only, you can set up a custom plugin repository for them.

For information about setting up a custom plugin repository, see the IntelliJ Platform SDK documentation.

Once you set up your plugin repository, add it to PyCharm:

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Plugins.

  2. On the Plugins page, click The cogwheel icon and then click Manage Plugin Repositories.

  3. In the Custom Plugin Repositories dialog, click The Add icon and specify your repository URL. It must point to the location of the updatePlugins.xml file. The file can be on the same server as your custom plugins, or on a dedicated one.

  4. Click OK in the Custom Plugin Repositories dialog to save the list of plugin repositories.

  5. Click OK in the Settings/Preferences dialog to apply the changes.

To browse the custom plugin repository, type repository: followed by the URL of the repository in the Marketplace tab of the Plugins page. For example:

repository:"" myPlugin

Alternatively, you can replace the default JetBrains Plugin Repository with your custom repository URL. This can be helpful if you want only your custom repository plugins to be available from PyCharm. To do this, edit the platform properties or VM options file as described below. For more information, see Advanced configuration.

Replace the default plugin repository with a custom one

  1. From the main menu, select either Help | Edit Custom Properties or Help | Edit Custom VM Options.

  2. Add the property to the platform properties file or the option to the VM options file. For example:""""

    Make sure that there is no URL.

  3. Restart PyCharm.

If you replace the default plugin repository with a custom one, the search field on the Marketplace tab of the Plugins dialog will browse only the plugins in your custom repository.

Required plugins

A project may require plugins that add support for certain technologies or frameworks. You can add such plugins to the list of required plugins for the current project, so that PyCharm will verify that the plugins are installed and enabled. It will notify you if you forget about some plugin, or someone on your team is not aware about the dependency as they work on the project.

Add a required plugin for your current project

  1. Make sure that the required plugin is installed.

  2. In the Settings/Preferences dialog (Ctrl+Alt+S), select Build, Execution, Deployment | Required Plugins.

  3. On the Required Plugins page, click The Add icon and select the plugin. Optionally, specify the minimum and maximum version of the plugin.

    Add required plugin dialog

After the required plugin is added, when you open the project in PyCharm, it will notify you if the plugin is disabled, not installed, or requires an update.

Required plugin is disabled

Click the link in the notification message to quickly enable, install, or update the required plugin.

Last modified: 6 November 2019