PyCharm 2022.1 Help

Configure an interpreter using Vagrant

Ensure 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.

Configure a remote Python interpreter

  1. Ensure that you have downloaded and installed Python on your computer.

  2. Ensure that you have properly initiated and started Vagrant. Basically, you need to open the Terminal window and execute the following commands:

    $ vagrant init ubuntu/trusty64


    $ vagrant up

    See Vagrant documentation for more information.

  3. Press Ctrl+Alt+S to open the IDE settings and select Plugins.

  4. Install the Vagrant plugin.

  5. Do one of the following:

    • Click the Python Interpreter selector and choose Add Interpreter.

    • Press Ctrl+Alt+S to open the project Settings/Preferences and go to Project <project name> | Python Interpreter. Click Python interpreter and select Add.

  6. In the left-hand pane of the Add Python Interpreter dialog, click Vagrant:

    New Vagrant-based interpreter
  7. Click the Browse button next to the field Vagrant instance folder, and specify the desired Vagrant instance folder. This results in showing the link to Vagrant host URL.

  8. The Python interpreter path field displays the path to the desired Python executable. You can accept default, or specify a different one.

  9. Click OK. The configured remote interpreter is added to the list.

  10. You can go back in the Python Interpreter page, if necessary, and configure the path mappings:

    1. Click the Browse button:

      Path mapping
    2. In the dialog that opens add Add a path mapping or delete Delete a path mapping path mappings as desired.

Last modified: 31 March 2022