PyCharm 2018.2 Help

Configuring to Work on the VM


Consider the situation when you work on your project on one platform, but want to deploy and run it on a different one. This is where PyCharm helps a lot with its extensive support for remote interpreters.

The task of running a project on a virtual machine falls into several major steps:

  • First, you need to define a virtual box.

  • Second, you need to configure a remote interpreter to run in this virtual box.

  • Finally, you need to launch your script in the remote console.

Before you start

Make sure that outside of PyCharm you have already done the following:

  • Installed Oracle's Virtual Box.

  • Installed Vagrant.

  • Added the following executables to your system path:
    • vagrant.bat from your Vagrant installation. This should be done automatically by the installer.

    • VBoxManage.exe from your Oracle's VirtualBox installation.

In PyCharm, make sure that Vagrant plugin is enabled: on the main toolbar, click icons general settings svg, and In the Settings/Preferences dialog (Ctrl+Alt+S), open the page Plugins. Actually, this plugin is enabled by default:

vagrant plugin bundled

Now all the preliminary steps are over, and we are ready to start.

Creating a virtual box

In the Settings/Preferences dialog (Ctrl+Alt+S) (icons general settings svg on the main toolbar) click the page Vagrant, and enter the Vagrant executable and Vagrant instance folder.

If the boxes are already defined, they appear in the list, and you can select one.

vagrant virtual box

If there is no suitable virtual box, click icons general add svg to create a new one. Enter the box name and URL for downloading:

vagrant vbox add

After clicking OK, PyCharm downloads the VM template. Thus, the virtual box is created and added it to the environment.

Pay attention to the Vagrant menu commands under the Tools menu. These commands correspond to the standard Vagrant actions. Once a Vagrant box is created, you have to initialize it in project root. To do that, on the main menu, point to Tools | Vagrant, and then choose Init in Project Root:

vagrant node

First, choose folder, if required. Note that you have this choice if there are several projects opened in the same window:

vagrant select folder

Choose the Vagrant box you are going to initialize:

vagrant select box

Thus a Vagrantfile is created, and you can view and change it as required:


After initialization, perform the vagrant up command (choose Up on the Tools | Vagrant menu). PyCharm runs the vagrant up command, and shows its output in the console:

vagrant up
rm vagrant up

Configuring remote interpreter via virtual box

Now open the Settings/Preferences dialog box again (icons general settings svg on the main toolbar), and click the page Project Interpreter. Here you can select an interpreter from the drop-down list, but what if none of the suggested interpreters meets your needs? Then click the icon icons general gearPlain to define your own one. Choose Add Remote on the drop-down menu:

py interpreter types remote

In the Configure Remote Python Interpreter dialog box, you have to specify the server settings. These settings can be taken from the Vagrant configuration file you've already defined. All the server setting fields are filled with the values, taken from the Vagrant configuration file:

py configure remote interpreter vagrant

Note that the path mappings are defined automatically. However, you can click browseButton to add your own path mappings:

py path mappings

From this point on, you can run any script of your project on the VM:

vagrant run

What's next? Let's log in to the virtual box via SSH.

Connecting to the SSH terminal

Why do we need it it all? PyCharm lets you log in to your virtual box via SSH and work in its console without leaving the IDE. So, on the main menu choose Tools | Run SSH session.... If you have more than one host already defined, select the one you want to connect to:

vagrant console

Now that you have direct access to your virtual box, let's first make sure your project directory is properly mapped. To do that, just view the contents of the default vagrant's shared folder /vagrant, and launch one of the available scripts, for example,

vagrant map
Last modified: 12 October 2018