PyCharm 2016.3 Help

Configuring Remote Interpreters via Docker Compose

In this section:

Prerequisite

Before you start working with Docker Compose, make sure that the Docker Compose integration 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.

Limitation

As of this writing, Docker Compose integration in PyCharm is not supported on Windows.

Using Docker Compose to configure a remote interpreter

To configure a remote Python interpreter, follow these steps:

  1. In the Project Interpreters page of the Settings/Preferences dialog box, click /help/img/idea/2016.3/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 that opens, do the following:
    1. Click the radio button Docker Compose.
    2. Choose the desired server from the drop-down list, or click New.
    3. In the Configuration file(s) field, specify the required configuration files, by clicking /help/img/idea/2016.3/add.png.

      Use the toolbar /help/img/idea/2016.3/add.png, /help/img/idea/2016.3/delete.png, /help/img/idea/2016.3/arrowUp.png, /help/img/idea/2016.3/arrowDown.png to make up the list of coonfiguration files.

      Note that if the path points to a specific file (for example, docker-compose.yml), then this configuration will be used. If the path points to a directory, then the configuration is defined by the file docker-compose.yml and (if exists) docker-compose.override.yml.

    4. In the field Environment variables, specify the environment variables in the docker-compose.yml file. Click the browse button /help/img/idea/2016.3/browseButton.png next to this field, and specify the required environment variables using the toolbar buttons /help/img/idea/2016.3/add.png, /help/img/idea/2016.3/delete.png, /help/img/idea/2016.3/copy.png, /help/img/idea/2016.3/paste.png.
    5. Specify the service that represent your project.
    6. The Python interpreter path field displays the path to the desired Python executable. You can accept default, or specify a different one.
  4. Click OK in the Configure Remote Python Interpreter dialog box. The configured remote interpreter is added to the list.

From this point, autocompletion, code inspections, as well as other features, will be driven by the interpreter from the Docker container derived from the service description in docker-compose.yml file.

See Also

Reference:

Language and Framework-Specific Guidelines:

Last modified: 30 December 2016