PyCharm 2017.2 Help

Configuring Remote Interpreters via Vagrant

This feature is supported in the Professional edition only.


Before you start working with Vagrant, make sure that the Vagrant plugin is enabled. The plugin is bundled with PyCharm and is activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.

Besides that, make sure that the following prerequisites are met (outside of PyCharm):

  • Oracle's VirtualBox is installed on your computer.
  • Vagrant is installed on your computer, and all the necessary infrastructure is created.
  • The parent folders of the following executable files are added to the system PATH variable:
    • vagrant.bat or vagrant from your Vagrant installation. This should be done automatically by the installer.
    • VBoxManage.exe or VBoxManage from your Oracle's VirtualBox installation.
  • The required virtual boxes are created.

Configuring remote Python interpreter via Vagrant

To configure a remote Python interpreter

  1. In the Project Interpreters page of the Settings/Preferences dialog box, click /help/img/idea/2017.2/cogwheel_framed.png.
  2. From the drop-down list, choose Add Remote .

    The dialog box Configure Remote Python Interpreter opens.

  3. In this dialog box, click the radio button Vagrant:

    In this case, the remote server settings are taken from the vagrant configuration file, defined in the page Vagrant.

  4. Click the browse button /help/img/idea/2017.2/browseButton.png next to the field Vagrant instance folder, and specify the desired Vagrant instance folder.

    This results in showing the link to Vagrant host URL.

  5. The Python interpreter path field displays the path to the desired Python executable. You can accept default, or specify a different one.
  6. Click OK in the Configure Remote Python Interpreter dialog box. The configured remote interpreter is added to the list.
  7. Back in the Project Interpreter page, if necessary, configure the path mappings:
    1. Click /help/img/idea/2017.2/browseButton.png:
    2. In the dialog box that opens add (/help/img/idea/2017.2/add.png) or delete (/help/img/idea/2017.2/delete.png) path mappings as desired.
Last modified: 26 October 2017

See Also



Language and Framework-Specific Guidelines: