[PYTHON] [Django] Build a Django container (Docker) development environment quickly with PyCharm

Introduction

I usually use PyCharm for business, but it took me a while to find out about building a Django container development environment, so I will post the procedure to build it with the minimum configuration.

• This article is an introduction to the dedicated functions of PyCharm Professional (paid free period of 30 days). If you want to do it for free, please refer to another article Construction of container development environment using VS Code. VS Code has many powerful extensions that can be used for Django development.

Advance preparation

1. 1. Create a Django project

• If you already have a source under development, you can use it. This time, I will use a simple Django app created from the following command in the environment where Python is installed.

> pip install django
> django-admin startproject sampleApp
> cd sampleApp
sampleApp> python manage.py migrate

2. Creating a Dockerfile

Create a Dockerfile with the following content in the folder where you created the Django app.

FROM python:3.8

#Install if you have the required packages
# RUN apt install ~~~

RUN pip intall django

3. 3. Create docker-compose.yml

Similarly, create the following contents in the folder where you created the Django app.

docker-compose.yml

version: '3'
services:
  app:
    build: .
    ports:
      - "8000:8000"
    volumes:
      - './:/app/sampleApp'
    working_dir: '/app/sampleApp'
    container_name: sampleApp
    privileged: true
    tty: true

That's all for preparation. The directory structure up to this point is as follows.

Django-docker-sample-pycharm　#This workspace folder
|   docker-compose.yml
|   Dockerfile
|
\---sampleApp
    |   db.sqlite3
    |   manage.py
    |
    \---sampleApp
        |   asgi.py
        |   settings.py
        |   urls.py
        |   wsgi.py
        |   __init__.py

Remote interpreter settings

Open the workspace folder in PyCharm. Then select [File]-> [Settings]-[Python Interpreter] to open the screen for adding an interpreter.

Select Docker Compose and open the [Server] new creation screen.

Create with OK without changing anything in particular.

Then select [app] from the [Service] pull-down menu and click OK to complete the setting.

It is OK if the remote interpreter is displayed on the interpreter setting screen. I was running "pip install django" in my Dockerfile, so Django is showing up in the list of packages. Let's complete the setting with OK.

This completes the setting "This project uses the container interpreter created from docker-compose.yml directly under the workspace folder": cat2:

Let's do it!

From here, let's run server as usual.

Django settings from [File] → [Settings]

[Add Configurations]

[＋]→[Django Server]

Set Name and Host and OK

Run! You can also debug from the button with the bug mark next to it.

If you access <http: // localhost: 8000> from your browser and the Django test page is displayed, it's OK!

If you look at the console, you can see that it is running inside the sampleApp container.

Of course you can also use breakpoints in debug mode!

It's a paid function that you can use the remote interpreter so easily. This will also improve development with containers: cat2: