PyCharm 2017.3 Help

Docker Compose

This feature is only supported in the Professional edition.

The following is only valid when Docker Integration Plugin is installed and enabled!

Prerequisites

Make sure that the following prerequisites are met:

Note that PyCharm supports docker-compose configuration versions 1.0 and up to 3.1.

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 macOS, it won't be shown in PyCharm running on Windows platform. On macOS, 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 Configure Remote Python Interpreter dialog box.

Last modified: 28 March 2018

See Also

Language and Framework-Specific Guidelines: