Configure an interpreter using Docker Compose

Press CtrlAlt0S to open the IDE settings and select Languages & Frameworks | Django. Ensure that the Enable Django Support checkbox is selected. Then click OK to close the project settings.

Download the project archive from GitHub, unpack it, and save it on the local drive.

Select File | Open from the main menu and specify the path to the downloaded project.

PyCharm can suggest creating a virtual environment based on the project requirements recorded in the requirements.txt file.

Click OK to create an environment.

In the Project tool window, right-click the project root and select New | File from the context menu. Enter the filename: Dockerfile.

Copy and paste the following code in the Dockerfile file:

FROM python:3.6.7

WORKDIR /app

# By copying over requirements first, we make sure that Docker will cache
# our installed requirements rather than reinstall them on every build
COPY requirements.txt /app/requirements.txt
RUN pip install -r requirements.txt

# Now copy in our code, and run it
COPY . /app
EXPOSE 8000
CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]

Then right-click the project root again, select New | File from the context menu, and create the docker-compose.yml file.

Copy and paste the following code into the docker-compose.yml file.

version: '2'
services:
    web:
        build: .
        ports:
            - "8000:8000"
        volumes:
            - .:/app
        links:
            - db

    db:
        image: "postgres:9.6"
        ports:
            - "5432:5432"
        environment:
            POSTGRES_PASSWORD: hunter2

tip

If needed, you can use variable substitution in the docker-compose.yml file, for example:

db:
    image: "postgres:${POSTGRES_VERSION}"

This file defines two services: web and db, and links them together.

Press CtrlAlt0S to open the IDE settings and select Build, Execution, Deployment | Docker.

Click to create a Docker server. Accept the suggested default values:

macOS

Windows

note

The Path mappings settings are not available on Linux. So, if you want to map some directories on a virtual machine to some path on your local Linux machine, you will have to do it manually.

Click OK to save changes.

Do one of the following:

• Click the Python Interpreter selector and choose Add New Interpreter.

• Press CtrlAlt0S to open Settings and go to Project: <project name> | Python Interpreter. Click the Add Interpreter link next to the list of the available interpreters.

• Click the Python Interpreter selector and choose Interpreter Settings. Click the Add Interpreter link next to the list of the available interpreters.

Select On Docker Compose.

Select an existing Docker configuration in the Server dropdown.

Alternatively, select Create new and perform the following steps to create a new Docker configuration:

Create a Docker configuration

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 connection settings.

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

For more information about mapping local paths to the virtual machine running the Docker daemon when using Docker on Windows or macOS, see Virtual machine path mappings for Windows and macOS hosts. You will not be able to use volumes and bind mounts for directories outside of the mapped local path.

This table is not available on a Linux host, where Docker runs natively and you can mount any directory to the container.

In Configuration files, specify the docker-compose.yml file. Also select the service.

Optionally, specify environment variables.

Wait until PyCharm creates and configures a new target:

Next, select an interpreter to use in the container. You can choose any virtualenv or conda environment that is already configured in the container, or select a system interpreter.

Click OK.

The configured remote interpreter is added to the list.

To execute a Django application, run a migration. Select Tools | Run 'manage.py' task from the main menu and enter migrate:

(See Run tasks of manage.py for details.)

Create a run/debug configuration for the Django server. To do that, from the main menu select Run | Edit Configurations. In the dialog that opens click and select Django Server:

The Host field must be set to 0.0.0.0 — to make sure that we listen to requests coming from outside the Docker container. To allow the server to start at this address, add 0.0.0.0 to the ALLOWED_HOSTS list in settings.py.

To run the newly created configuration, select Run | Run 'RunDjangoApp' from the main menu.