PyCharm 3.4.0 Web Help

Some features described here are available in Professional edition only.

In this section:



Before you start working with Vagrant, make sure that Vagrant plugin is enabled.

The plugin is bundled with PyCharm and activated by default. If not, enable the plugin 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.
To configure a remote Python interpreter via Vagrant
  1. In the Project Interpreter page of the project settings, click cogwheel_framed .
  2. In the drop-down list, choose Add Remote .


  3. In the dialog box Configure Remote Python Interpreter, click the radio-button Vagrant:


  4. Do the following:
    • Click the browse button browseButton next to the field Vagrant Instance Folder, and specify the desired Vagrant instance folder .

      This will result in showing the link to Vagrant host URL.

    • The Python interpreter path field displays the path to the desired Python executable. You can accept default, or specify a different one.
  5. Click OK in the Configure Remote Python Interpreter dialog box.

    PyCharm will show the suggestion to launch Vagrant instance under the specified Vagrant instance folder, if it is not yet running.

    The configured remote interpreter is added to the list.

See Also


Language and Framework-Specific Guidelines:


Web Resources: