この記事では、Python + djanog の開発環境をVSCodeを利用してWindows上に構築する手順を、出来る限りわかり易くご紹介しています。
Visual Stadio Code のインストール
下記より VSCodeのインストーラをダウンロード
ここではWindows環境での構築になりますので、Windows用のインストーラを選択します。
ダウンロードされた VSCodeUserSetup-x64-X.XX.X.exe を （X.XX.Xはバージョンにより異なる）をダブルクリックしてインストールを行います。
VSCode日本語化
VSCodeを日本語化する場合は「拡張機能」で「Japanese Language Pack for Visual Studio Code」も併せてインストールしておきます。
Japanese Language Pack for Visual Studio Codeのインストール後はVSCodeの再起動を行うとメニューなどが日本語化された状態で表示されるようになります。
Pythonのインストール
次にVSCodeを起動して左メニューの「拡張機能」をクリック、検索ボックスに python と入力して Install を実行します。
Python 仮想環境の作成
開発環境の構築は仮想環境内で行っていきます。もし失敗した場合にも他の環境に影響がなく、複数の環境を作ることも容易だからです。
仮想環境の作成はVSCodeのターミナルでコマンドを実行します。
ここでは venv という名前で作成しています。
なお、コマンドを実行したディレクトリ内に仮想環境名でフォルダが作成されます。
仮想環境が不要になった場合は、ディレクトリごと削除することで仮想環境の削除が可能です。
PS F:\python> python3 -m venv venv
PS F:\python> dir
d----- 2022/11/20 15:26 venv
仮想環境の実行
実行環境を仮想環境に切り替えるには、作成した仮想環境フォルダ内のScriptsフォルダ内のactivateファイルを実行します。
仮想環境に入ると、コンソールの先頭に仮想環境名が付与されます。ここでは(venv)と表示されています。
PS F:\python> .\venv\Scripts\activate
(venv) PS F:\python>
djangoのインストール
djangoはWebアプリケーションを作るためのフレームワークです。
djangoをインストールすると、djangoアプリケーションの他に開発環境用の簡単なWEBサーバも含まれていますので、これだけでWEBブラウザからも動作確認を行うことが出来るようになります。
インストールは下記コマンドで行います。
(venv) PS F:\python> pip3 install django
djangoプロジェクトの作成
ここでは仮想環境の中にdjangoプロジェクトを作成します。
プロジェクトの作成は django-admin startproject <プロジェクト名> という形でコマンド実行します、ここではprojectという名前で作成しています。
コマンドを実行した場所にプロジェクトフォルダが作成される為、どこにでもプロジェクトフォルダを作成できますが、管理がやり易いように仮想環境のフォルダ内に作成していきます。
(venv) PS F:\python> cd venv
(venv) PS F:\python\venv> django-admin startproject project
(venv) PS F:\python\venv> dir
ディレクトリ: F:\python\venv
Mode LastWriteTime Length Name
---- ------------- ------ ----
d----- 2022/11/20 15:26 Include
d----- 2022/11/20 15:26 Lib
d----- 2022/11/26 14:28 project
d----- 2022/11/20 16:03 Scripts
d----- 2022/11/20 15:29 share
-a---- 2022/11/20 15:26 165 pyvenv.cfg
アプリケーションの作成
アプリケーションとは、実際に何らかの処理を行う Web アプリケーションです。
アプリケーションはプロジェクトの中に複数作成することが可能です。
ここでは app というアプリケーションを作成していきます。コマンドの実行は manage.py ファイルと同じ階層で行います。
(venv) PS F:\python\venv> cd project
(venv) PS F:\python\venv\project> python manage.py startapp app
(venv) PS F:\python\venv\project> dir
ディレクトリ: F:\python\venv\project
Mode LastWriteTime Length Name
---- ------------- ------ ----
d----- 2022/11/26 15:06 app
d----- 2022/11/26 15:06 project
-a---- 2022/11/26 14:28 685 manage.py
テンプレートファイルの格納ディレクトリを作成
アプリケーションフォルダの直下にテンプレート（HTMLファイル）を配置するためのディレクトリを作成しておきます。
(venv) PS F:\python\venv\project> cd app
(venv) PS F:\python\venv\project\app> mkdir templates
ディレクトリ: F:\python\venv\project\app
Mode LastWriteTime Length Name
---- ------------- ------ ----
d----- 2022/11/26 15:58 templates
ここまでで、仮想環境の作成、プロジェクトの作成、アプリケーションの作成まで完了し下記のようなディレクトリ構成になります。
venv
├── Include
├── Lib
│ └── site-packages
├── project
│ ├── app
│ │ ├── migrations
│ │ │ └── __init__.py
│ │ ├── templates
│ │ ├── __init__.py
│ │ ├── admin.py
│ │ ├── apps.py
│ │ ├── models.py
│ │ ├── tests.py
│ │ └── views.py
│ ├── project
│ │ ├── __pycache__
│ │ │ ├── __init__.cpython-310.pyc
│ │ │ └── settings.cpython-310.pyc
│ │ ├── __init__.py
│ │ ├── asgi.py
│ │ ├── settings.py
│ │ ├── urls.py
│ │ └── wsgi.py
│ └── manage.py
├── Scripts
│ ├── activate
│ ├── activate.bat
│ ├── Activate.ps1
│ ├── deactivate.bat
│ ├── django-admin.exe
│ ├── f2py.exe
│ ├── fonttools.exe
│ ├── pip.exe
│ ├── pip3.10.exe
│ ├── pip3.exe
│ ├── pyftmerge.exe
│ ├── pyftsubset.exe
│ ├── python.exe
│ ├── pythonw.exe
│ ├── sqlformat.exe
│ └── ttx.exe
├── share
│ └── man
│ └── man1
│ └── ttx.1
└── pyvenv.cfg
django プロジェクトの環境設定
プロジェクトフォルダ内にあるsettings.pyファイルを編集します。
ここでは .\project\project\settings.py
接続許可設定に全てを設定
ALLOWED_HOSTS = ['*']
INSTALLED_APPSにアプリケーションの定義を追加
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'app',
]
テンプレートファイルの配置ディレクトリを指定
尚、デフォルトの空白設定の場合は ‘APP_DIRS’: True の設定があるため、アプリケーションフォルダ内の templates フォルダを自動的に探索することになる。
そのため、ここでは DIRS に BASE_DIR / ‘templates’ を設定しているが、空白のままでも動作は変わらない。
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [BASE_DIR / 'templates'],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]
言語を日本語に、タイムゾーンを日本時間に変更。
LANGUAGE_CODE = 'ja'
TIME_ZONE = 'Asia/Tokyo'
djangoの実行と動作確認
manage.py runserver でdjangoアプリケーションサーバを実行します。
実行する場所はプロジェクトフォルダの直下です。（manage.pyファイルのある場所）
(venv) PS F:\python\venv\project> python manage.py runserver
Watching for file changes with StatReloader
Performing system checks...
System check identified no issues (0 silenced).
You have 18 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions.
Run 'python manage.py migrate' to apply them.
November 26, 2022 - 16:04:56
Django version 4.1.3, using settings 'project.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CTRL-BREAK.
以上で開発環境サーバで実行は完了です。ブラウザで http://127.0.0.1:8000 にアクセスすると実際の実行画面を確認できます。
停止はターミナル上で Ctrlキー＋Cキーです。
マイグレーションエラーは下記コマンドでマイグレーション実行で表示されなくなります。
(venv) PS F:\python\venv\project> python manage.py migrate
まとめ
ここでは、Windows環境に、python × django の開発環境を VSCodeを利用して構築する手順をご紹介しました。
余談ですが、様々な環境構築の方法の中でも、無料の環境構築で最も手っ取り早い方法はVisual Studio Community を使った方法です。
ここで行った設定がインストール後の設定でナビに沿って選択していくだけで簡単に行えるようになっています。
