PyCharm 2016.1 Help

Docker Compose


Make sure that the following prerequisites are met:

  • You are working on Linux or OS X platform.
  • Docker Compose is installed, as described on the page Docker Compose.
  • Before you start working with Docker Compose, make sure that Docker integration plugin is enabled. The plugin is bundled with PyCharm and activated by default. If it is not, enable the plugin as described in the section Enabling and Disabling Plugins.

Important note

A chosen service declared within a Docker Compose configuration file is supported as a Python interpreter. Python run configurations based on this interpreter operate like docker-compose up command with the addition that it maps project sources into the chosen service container.

The feature works for Linux with the local installations of Docker and OS X, it won't be shown in PyCharm running on Windows platform. On OS X, Docker Compose configuration file must be situated within the default shared folder /Users/.

Working with Docker Compose

In the Settings/Preferences dialog box, expand the node Build, Execution, Deployment, and in the Docker page, add the required Docker and then specify the Docker Compose executable.

As a result, the Docker Compose option appears in the Add Remote dialog box.

See Also


Language and Framework-Specific Guidelines:

Last modified: 20 April 2016