PyCharm 2016.2 Help

Docker

Prerequisites

Make sure that the following prerequisites are met:

  • Docker is installed, as described on the page Docker Docs. You can install Docker on the various platforms:
  • Before you start working with Docker, make sure that the Docker integration plugin is enabled. The plugin is bundled with PyCharm and is activated by default. If it is not, enable the plugin as described in Enabling and Disabling Plugins.

Overview of Docker support

The Docker integration plugin adds the following to PyCharm:

  • Docker configurations. These are named sets of settings for accessing the Docker Remote API.
  • Docker Deployment run/debug configurations. They let you download and build Docker images, and create and start Docker containers. Application debugging is supported only for Python.
  • Docker tool window that lets you manage your Docker images and containers.
  • Docker Registry configurations that represent your Docker image repository user accounts.
  • Additional setting in the Python run/debug configuration.

Working with Docker: Process overview

  1. Install Docker and start the Docker daemon (on Windows and OS X - along with the Docker VM in which it runs). For corresponding instructions, see Get Started with Docker.
  2. Make sure the Docker integration plugin is enabled.
  3. Create a Docker configuration. You can do that:
    • Separately, in the Settings / Preferences dialog: Ctrl+Alt+S | Build, Execution, Deployment | Docker | add | Docker.
    • When creating a Docker Deployment run configuration: Run | Edit Configurations | add | Docker Deployment, etc.
  4. Create the Docker-based remote interpreter.
  5. Create and run the Python run/debug configuration that makes use of Docker.
  6. Use the Docker Tool Window to manage your Docker images, containers and deployed applications.

See Also

Last modified: 29 August 2016