IntelliJ IDEA 2022.2 Help

Configure remote Python interpreters

IntelliJ IDEA provides full integration with the Python interpreters running on remote hosts.

Depending on the type of the remote interpreter, follow one of the procedures:

Configure an interpreter using SSH

  1. Make sure that the following prerequisites are met:

    • An ssh server should run on a remote host, since IntelliJ IDEA runs remote interpreters via ssh-sessions.

    • If you want to copy your sources to a remote computer, create a deployment configuration, as described in the section Create a remote server configuration.

  2. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

    Adding a new SDK
  3. In the Project Structure dialog, select SDKs under the Platform Settings section, click Add a new SDK, and choose Add Python SDK from the popup menu.

    Adding a new Python SDK
  4. In the left-hand pane of the Add Python Interpreter dialog, select SSH Interpreter.

  5. Select New server configuration, then specify server information (host, port, and username).

    adding an interpreter via SSH

    Alternatively, you can select Existing server configuration and choose any available deployment configuration from the list.

    existing configurations

    If needed, click the Browse button to review the Connection settings, Mappings, and Excluded paths for the selected deployment configuration. Click Next to continue configuring an interpreter.

  6. In the next dialog window, provide the authentication details to connect to the target server.

    specifying authentication details

    Select Password or Key pair (OpenSSH or PuTTY) and enter your password or passphrase. If Key pair (OpenSSH or PuTTY) is selected, specify:

    • Private key: location of the file with a private key

    • Passphrase: similar to a password, it serves to encrypt the private key.

    Click Next to proceed.

  7. In the next dialog window, verify the path to the desired Python interpreter. You can accept the default, or specify a different one. You have to configure the path mappings between your local project and the server. To do that, click the Browse button next to the Sync folders field and enter the path to the local project folder and the path to the folder on the remote server.

    Setting SSH mappings

    You can also select the checkbox to enable automatic upload of the local changes to the remote server.

  8. Click Finish.

    The configured remote interpreter is added to the list.

Configure an interpreter using Vagrant

  1. Make sure that the following prerequisites are met:

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

  2. Make sure that the Vagrant plugin is installed and enabled.

  3. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

    Adding a new SDK
  4. In the Project Structure dialog, select SDKs under the Platform Settings section, click Add a new SDK, and choose Add Python SDK from the popup menu.

    Adding a new Python SDK
  5. In the left-hand pane of the Add Python Interpreter dialog, select Vagrant.

    Add a remote interpreter using Vagrant
  6. Specify the path to the Vagrant instance folder in Vagrant Instance Folder.

    Wait until you see a link in Vagrant Host URL.

  7. In Python interpreter path field, specify the path to the Python executable. You can accept the default, type in a different path, or click the Browse button to browse.

  8. Click OK.

    The configured remote interpreter is added to the list.

Configure an interpreter using WSL

  1. Click the Windows button in the lower-left corner of the screen and start typing System Information. To ensure that your system works well with WSL, upgrade your Windows to the latest available version.

  2. Install the Windows Subsystem for Linux and initialize your Linux distribution as described in the WSL Installation Guide.

  3. If your Linux distribution doesn't come with rsync, you need to install it:

    sudo apt install rsync

    sudo pacman -S rsync

  4. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

    Adding a new SDK
  5. In the Project Structure dialog, select SDKs under the Platform Settings section, click Add a new SDK, and choose Add Python SDK from the popup menu.

    Adding a new Python SDK
  6. In the left-hand pane of the Add Python Interpreter dialog, select WSL.

    Add a remote interpreter using WSL
  7. Select the Linux distribution with the required Python interpreter.

  8. In Python interpreter path field, specify the path to the Python executable. You can accept the default, type in a different path, or click the Browse button to browse.

  9. Click OK.

    The configured remote interpreter is added to the list.

Configure an interpreter using Docker

  1. Make sure that the following prerequisites are met:

    • Docker is installed, as described in the Docker documentation.

    • You have a stable Internet connection.

      Ensure that you have a stable Internet connection, so that IntelliJ IDEA can download and run busybox:latest. Once you have successfully configured Docker, you can go offline.

    Note that you cannot install any Python packages into Docker-based project interpreters.

  2. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

    Adding a new SDK
  3. In the Project Structure dialog, select SDKs under the Platform Settings section, click Add a new SDK, and choose Add Python SDK from the popup menu.

    Adding a new Python SDK
  4. In the left-hand pane of the Add Python Interpreter dialog, select Docker.

    Adding a Python interpreter using Docker
  5. Do one of the following:

    • Select an existing Docker configuration in the Server dropdown.

    • Click New to add a Docker configuration and specify how to connect to the Docker daemon.

      The connection settings depend on your Docker version and operating system. For more information, see Docker configuration settings.

      The Connection successful message should appear at the bottom of the dialog.

      The Docker connection settings for interpreter

      For more information about using the Docker integration with IntelliJ IDEA, see Docker.

  6. Specify the image and the path to the Python executable:

    Configuring a Python interpreter using Docker
  7. Click OK.

    The configured remote interpreter is added to the list.

Configure an interpreter using Docker Compose

  1. Make sure that the following prerequisites are met:

    • Docker is installed, as described in the Docker documentation.

    • You have a stable Internet connection.

      Ensure that you have a stable Internet connection, so that IntelliJ IDEA can download and run busybox:latest. Once you have successfully configured Docker, you can go offline.

    Note that you cannot install any Python packages into Docker-based project interpreters.

  2. Define necessary services in one or several Docker Compose files.

  3. Navigate to File | Project Structure or press Ctrl+Alt+Shift+S.

    Adding a new SDK
  4. In the Project Structure dialog, select SDKs under the Platform Settings section, click Add a new SDK, and choose Add Python SDK from the popup menu.

    Adding a new Python SDK
  5. In the left-hand pane of the Add Python Interpreter dialog, select Docker Compose.

    Adding a Python interpreter using Docker Compose
  6. Do one of the following:

    • Select an existing Docker configuration in the Server dropdown.

    • Click New to add a Docker configuration and specify how to connect to the Docker daemon.

      The connection settings depend on your Docker version and operating system. For more information, see Docker configuration settings.

      The Connection successful message should appear at the bottom of the dialog.

      The Docker connection settings for interpreter

      For more information about using the Docker integration with IntelliJ IDEA, see Docker.

  7. In the Add Python Interpreter dialog, specify the docker server and the docker-compose.yml file. Also select the service.

    Configuring a Python interpreter using Docker Compose

    Optionally, specify environment variables.

  8. Finally, specify the path to the Python executable:

    Configuring a Python interpreter using Docker Compose
  9. Click OK.

    The configured remote interpreter is added to the list.

For any of the configured Python interpreters (but Docker-based), you can:

Last modified: 27 September 2022