PyCharm で Django の開発を行うには？

PyCharm で Django の開発を行うには？

Django の開発は、Python がベースになります。前回紹介したように、Python の開発を行う場合、PyCharm は便利な開発環境です。この記事では PyCharm の設定のやり方を Windows10 の場合を例にして紹介します。

PyCharm とは？

プログラミング言語 Python の IDE(Integrated Development Environment)です。JetBrains という会社が開発提供しています。Windows や MacOS をはじめとして、Linux でも活用可能な開発ツールです。

無料でできるコミュニティ版と、有料のプロフェッショナル版がリリースされています。今回は、無料で利用可能のコミュニティ版を中心に紹介します。

ダウンロードは、インターネットのJetBrains のサイトから行います。サイトに行くと利用している OS を検出して、必要なページに自動で振り分けています。

今回は、無料で利用できるコミュニティ版をダウンロードして利用します。

PyCharm のインストール

ダウンロードしたら、ダウンロードしたファイル、この例では「pycharm-community-2021.1.exe」をクリックしてインストールを実行します。 インストール先の設定です。

その他の設定に関するものです。必要に応じて有効にしてください。基本機能は、標準の設定（どれもチェックしない状態）で使用できます。

インストール先のフォルダの設定も標準設定で OK OK です。

あとは、インストールを実行して終了するまで待つだけです。

Django プロジェクトの作成

PyCharm で Python のプロジェクトの作成も可能ですが、Django の開発を行う場合、Windows PowerShell で仮想環境の設定と、Django のプロジェクトを先に作成した方が管理がやりやすいので、この記事では先に Django のプロジェクトを Power Shell で作成します。

PowerShell のスクリプト実行を有効にする

Windows10 の標準設定では、PowerShell のスクリプトの実行にはセキュリティ対策として制限がかけられています。仮想環境の設定にはスクリプトを実行することがあるので最初に設定を変更して、PowerShell でスクリプトが実行できるようにします。（もしくは、コマンドプロンプトを使用します）

設定の変更は、Windows PowerShell を管理者モードで立ち上げます。スタートメニューから PowerShell を実行する際に、マウスの右ボタンを PowerShell の起動メニュー上でクリックします。

そのあとで以下のコマンドを実行します。

> Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope CurrentUser

これで、スクリプトが実行できるようになりました。

仮想環境を作成する

Windows10 の場合、Python に組み込まれている仮想環境のモジュール「venv」を利用します。

Django のプロジェクトごとに仮想環境を設定することを前提に考えると、新規にプロジェクト用のフォルダを作成した方がシンプルです。この例では、「Documents」の下に「sample」というフォルダを作成します。

作成後作成したフォルダに移動して、仮想環境を作成するコマンドを実行します。

> cd Documents

> mkdir sample

> cd sample

> python -m venv sample_env

実行後は、作成した「sample」フォルダの下に、「sample_env」というフォルダが作成されます。仮想環境に必要なファイルはこのフォルダの下に作られます。

作成した仮想環境を有効にするために、以下のスクリプトを実行します。

> sample_env/Scripts/activate

(sample_env) >

プロンプトの前に仮想環境の名前が表示されるようになって、仮想環境が有効になったことがわかります。

Django のインストール

仮想環境を有効にした状態で、Django をインストールします。このように Django をインストールすることで、Windows10 のシステム環境には影響がない状態で、Django を利用することができます。

(sample_env) > pip install django

これで、仮想環境下で Django が使えるようになりました。 Django のバージョンの確認は、

(sample_env) > django-admin --version

3.1.7

で確認できます。

Django のプロジェクトを作成します

作成した、「samples」のフォルダで、Django のプロジェクトを作成するコマンドを実行します。例では、「djangotest」というプロジェクトを作成します。

(sample_env) > django-admin startproject djangotest

「sample」フォルダの下にプロジェクト名と同じフォルダ「djangotest」が作成されます。

ここまでが、Django のプロジェクトを作成する手順になります。

PyCharm の設定

PyCharm を起動します、メニューのフォルダ名を変えていない場合は、スタートメニューの「JetBrains」というフォルダにあります。（PyCharm ではないので注意してください！）

起動出来たら、既にプロジェクトを作成しているので「Open」を選んでください。

先ほど作成した「djangotest」のフォルダを選んでください。

メニューバーの「File」を選択して表示されるメニューから「settings ...」を選ぶとサブウインドウが表示されます。

左側のメニューから「Project: djangotest」を選ぶと、「Python Interperter」と「Python Structure」が表示されるので、「Python Interperter」を選びます。

右側の表示が切り替わるので右上の設定のアイコンをクリックします。 

 「Add」と「Show all」が表示されるので「Add」を選びます。 

 「Virtual Environment」を選択して、「Existing environment」を選択して右端のアイコンをクリックして、Python のインタープリターを選択します。 

 「samples\sample_env\Scripts\python.exe」を選びます。あとは、「OK」をクリックして戻ります。 

仮想環境が選択されて、Django が利用可能になっているのがわかります。さらに「OK」をクリックして最初のメインウインドウに戻ります。

管理用スクリプト「manage.py」の設定例も挙げておきます。

「Add Configuration」を選択します。 別のウインドウが立ち上がるので、左上の「＋」か、右側のウインドウに表示される「Add new run configuration」をクリックします。メニューが表示されるので「Python」を選択します。 

 設定のウインドウに切り替わるので、設定の名前と、スクリプト「manage.py」管理用のパラメータ「runserver」を入力・選択します。

 あとは「OK」をクリックしてメインのウインドウに戻ります。

先ほどまで、左上の「Add Configuration」と表示されていた部分が、設定した「Development Server」に変わっていると思いますので、その右側のプレイボタンをクリックすると、開発用の Web サーバーが起動されます。

同じ要領で、管理用のよく利用するスクリプトを登録しておくと、毎回タイプしてコマンドを実行しなくても良いので便利です。

まとめ

この記事では Django のプロジェクトを作成して、PyCharm を利用するための初期設定のやり方を紹介しました。

一旦設定を行ってしまうと、仮想環境の設定を毎回行う必要はありません。PyCharm を起動して、プロジェクトを選択すれば仮想環境の設定は最初に行っているので、2 回目以降は不要です。コマンドラインから管理用のコマンドも、一番下のメニューから「Terminal」を選択すれば、仮想環境が有効になったコマンドラインを利用できるようになっています。

基本的な開発に必要な機能はほぼ揃っているので、最初の設定は多少面倒なところはありますが、そのあとの開発はスムーズにすすめることができます。

Django のフレームワークを活用した開発を行う場合おすすめの開発ツールです。