【Python】Djangoとは？インストール方法から開発環境構築まで

これからPythonフレームワークであるDjangoを始めたい初心者・入門者は、Djangoの実行環境を準備する必要があります。

そのために、Djangoのインストールのほかに実行環境構築も実施しなければ使えません。

ここでは、以下の悩みをお持ちの方に読み進めていただきたいです。

これらの悩みを解決しながら、Djangoのインストールと設定・環境構築を解説します。

記事を読み終えると、Djangoアプリケーション実行環境と初期Djangoプロジェクトの構造が理解できます。

Django（ジャンゴ）とは？

Django（ジャンゴ）は、Python製のWebフレームワークです。

PythonのWebフレームワークの中で最も利用者数が多いフレームワークになります。

また、Python製のフルスタックWebフレームワークを利用するなら現状でDjango一択です。

ライブラリとフレームワークの違い

アプリ開発を始めると、ライブラリやフレームワークなどを多用することになります。

また、図解がないと立ち位置が分からず理解しづらいです。

ここでは、例としてPythonの代表的なフレームワークを記載します。

ライブラリとフレームワークの役割と概念理解に注意しましょう。

PythonとDjangoのバージョンと注意点

Djangoのバージョンは、Pythonのバージョンと密接に関連しています。

サポートが終了したPythonバージョンは、Pythonプロジェクトによって保守されなくなるためDjangoで使用すべきではありません。

Djangoの特徴

DjangoにはWebフレームワークとして以下の特徴があります。

Djangoは、別のPython製フレームワークと比べて開発規模が大きい場合に利用されます。

【Djangoの特徴】フルスタックWebフレームワーク

改めて、DjangoはフルスタックWebフレームワークです。

そのため、中規模以上のWebアプリケーション開発に用いられます。

また、Djangoをインストールすると次のような機能が利用できます。

また、Django REST framework（DRF）を追加インストールすると、WebアプリだけでなくREST API（RESTful API）が作れます。

【Djangoの特徴】MVTモデルの採用

Djangoでは、UIを持つアプリを実装するデザインパターンとしてMTV（Model/View/Template）モデルを採用しています。

Model/View/Templateは以下の役割を持ちます。

一般的に、MVCモデル（Model/View/Controller）が有名ですが、MTVのViewはMVCのControllerに相当し、MTVのTemplateはMVCのViewに相当します。

【Djangoの特徴】セキュリティ機能の装備

Djangoはいくつかセキュリティ機能が標準装備されており、他のPython製フレームワークよりもセキュリティ対策が充実しています。

以下は、Django標準のセキュリティ機能一覧になります。

# views.py
from django.shortcuts import render

def hello(request):
    name = request.GET.get("name", "")
    return render(request, "hello.html", {"name": name})

<p>こんにちは、{{ name }} さん！</p>

<p>こんにちは、<script>alert(1)</script> さん！</p>

<!-- template.html -->
<form method="POST" action="/comment/">
  {% csrf_token %}
  <input type="text" name="comment">
  <button type="submit">送信</button>
</form>

# views.py
from django.views.decorators.csrf import csrf_exempt
from django.shortcuts import render

def post_comment(request):
    if request.method == "POST":
        ...
    return render(request, "template.html")

# 安全：Django ORM
from myapp.models import User

user = User.objects.filter(username=request.GET.get('username')).first()

その他、Djangoのセキュリティ対策一覧の詳細情報を知りたい人は公式ドキュメントから確認できます。

Django Project

Django におけるセキュリティ | Django ドキュメント The web framework for perfectionists with deadlines.

Djangoでできること

Djangoが活用されるケースは、主に以下の2つで活用されます。

ここでは、簡単にDjangoがWebアプリ＆API開発に強い理由をまとめています。

Webアプリケーション開発

再三記載していますが、DjangoはフルスタックWebフレームワークです。

そのため、Webアプリに必要な機能がはじめから揃っています。

上記の機能が最初から揃っているため、開発者はビジネスロジックに集中できます。

「小規模な個人アプリ」から「大規模な商用サービス」まで幅広く対応できます。

また、Djangoを使ったWebアプリのサービス例が以下になります。

特にデータ中心のWebサービス（SNS・CMS・ECサイト）に最適です。

WebAPI開発

DjangoはHTML生成だけでなく、「データをAPIとして外部に提供する」ことも得意です。

特に拡張ライブラリDjango REST Framework（DRF）を使うことで、JSONレスポンスを返すRESTful APIを高速に構築できます。

また、Djangoを使ったAPI開発のサービス例が以下になります。

Djangoは「データベースと外部クライアント（フロント・モバイル）をつなぐシステム」として活用されます。

強力なORMと認証機構を活かして、APIサーバーを短時間で構築できます。

Djangoを利用するためのPython開発環境構築

PythonのWebフレームワークであるDjangoを利用するには、Pythonの開発環境構築が必要です。

Pythonの開発環境を構築するために、以下の手順を示します。

本記事では、Djangoのインストールからメインに記載しておりますが、PythonとVSCodeインストールがまだできていない人は「【Python】ダウンロードとインストール方法から実行環境構築まで」を一読ください。

あわせて読みたい

【Python】ダウンロードとインストール方法から実行環境構築まで これからPythonを始めたい初心者・入門者は、個人PCへのPython実行環境を準備する必要があります。 そのために、Pythonのダウンロード・インストールのほかに実行環境構…

Pythonにてローカル環境に仮想環境を作成する

Pythonで開発を実施する際、開発プロジェクトごとに専用の実行環境を作成し切り替えることができます。

また、開発用として一時的に作成する実行環境を「仮想環境」と呼びます。

ローカル環境で開発を進めるにあたり、venvモジュールを利用し仮想環境を構築します。

venvは、Pythonに標準搭載された仮想環境用モジュールです。

venvを利用することで、プロジェクトごとに分離したPython実行環境を構築できるため、各実行環境でそれぞれのパッケージを管理できます。

Pythonによる仮想環境の構築方法が知りたい人は、「【Python】ダウンロードとインストール方法から環境構築まで」を一読ください。

あわせて読みたい

【Python】ダウンロードとインストール方法から実行環境構築まで これからPythonを始めたい初心者・入門者は、個人PCへのPython実行環境を準備する必要があります。 そのために、Pythonのダウンロード・インストールのほかに実行環境構…

Djangoのインストール

本記事では、WindowsPCによる任意のディレクトリにて「django-project」を作成しています。

インストール自体は簡単で、以下のコマンドを実行しましょう。

pip install django

上記のコマンドを実行すると、最新バージョンであるDjangoのインストールが完了します。

また、バージョン指定によるDjangoのインストールを実施したい場合は、以下のコマンドで実行します。

pip install django==4.2.10

Djangoが依存するパッケージ

Djangoをインストールすると、Djangoが依存しているパッケージも同時にインストールされます。

また、インストールされたパッケージを確認するには、以下のコマンドで確認できます。

pip list

Djangoをインストールすることで同時にインストールされるパッケージは以下です。

Djangoで利用する代表的なモジュール

ここでは、Django本体に含まれる主要モジュールをカテゴリに分けてまとめています。

一つ一つのモジュールに関する詳細情報は別途調べましょう。（膨大にあるため）

Djangoのユーティリティコマンド

Djangoには、2種類のユーティリティコマンドがあります。

django-adminコマンドは、Djangoプロジェクト作成時にしか使いません。

manage.pyコマンドは、Djangoアプリケーション作成だけでなく様々な場面で使います。

django-adminコマンド

Djangoプロジェクトを作成する場合は、django-adminコマンドで自動作成できます。

django-admin startproject <プロジェクト名>

Django==5.2.7にて実行しています。

任意のディレクトリにてコマンドを実行すると、以下のディレクトリを自動作成します。

django_project
├── django_project
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
└── manage.py

また、ハイフンを含んだプロジェクト名などはDjangoにおいて命名規則に反することがあります。

上記のエラーが発生した場合は、別のプロジェクト名に変更しましょう。

manage.pyコマンド

manage.pyコマンドは、主にDjangoアプリケーションに対して操作を実行します。

Djangoアプリケーションの自動作成

Djangoアプリケーションを自動生成する場合は以下のコマンドを実行します。

python manage.py startapp <アプリケーション名>

Django==5.2.7にて実行しています。

ここでは、アプリケーション名をdjango_appと命名しています。

自動生成した場合、以下のディレクトリ構成が作成されます。

django_project
├── django_app
│   ├── migrations
│   │   └── __init__.py
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── tests.py
│   └── views.py
├── django_project
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
└── manage.py

django_appフォルダも含め、以降の階層内のフォルダ・ファイルも自動生成されています。

開発サーバー（runserver）の起動

Djangoプロジェクトをローカルマシンの環境で動作させるため、開発用サーバーを起動するコマンドは以下になります。

python manage.py runserver

上記のコマンドを実行し、http://127.0.0.1:8000/にアクセスしてみましょう。

初期状態のプロジェクトであれば、上記のような画像が表示されます。

マイグレーションの作成/実行/状況確認/ロールバック

モデルに記述したデータベーステーブル定義に基づき、マイグレーションファイルの自動生成/実行は以下になります。

python manage.py makemigrations

No installed app with labelエラーが出る場合は、解決方法としてsettings.pyのINSTALLED_APPSに<アプリケーション名>を追加します。

INSTALLED_APPS = [
    '<アプリケーション名>',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

python manage.py migrate

また、マイグレーションの履歴はDjangoが管理するテーブル（django_migrations）に保存されます。

履歴データを使い、マイグレーションの適用状況を確認あるいは以前の状態に戻すことができます。

以下のコマンドにて、マイグレーションの適用状況を確認できます。

python manage.py showmigrations <アプリケーション名>

showmigrationsコマンドもsettings.pyに追加しないとNo installed app with labelエラーが出るため注意しましょう。

例えば、以下のマイグレーション適用状況があるとします。

[X]0001
[X]0002
[ ]0003
[ ]0004

マイグレーションファイルの一覧と適用状況が[X]で表示されます。

[X]になっている舞う偽レーションファイルは適用済みを意味しています。

以下のコマンドにて、マイグレーションのロールバックを実行できます。

python manage.py migrate <アプリケーション名> 0001

[X]0001
[ ]0002
[ ]0003
[ ]0004

スーパーユーザーの作成

スーパーユーザー（サイト管理者）を作成するには、「createsuperuser」を指定します。

以下のコマンドを実行すると、ユーザー名とメールアドレスとパスワード入力が求められます。

入力を終えると、スーパーユーザーが作成された旨が表示されます。

python manage.py createsuperuser

Username: <任意のユーザー名>
Email address: <任意のメールアドレス>
Password: <任意のパスワード>
Password (again): <任意のパスワード>
Superuser created successfully.

http://127.0.0.1:8000/admin/login/?next=/admin/にアクセスしてみましょう。

作成したスーパーユーザーでログインすると、サイト管理画面にログインできます。

テストの実行

テストコードを実行するには、「test」を指定します。

テスト範囲を指定し実行することも可能です。

以下は、ケース例によるテストになります。

# プロジェクト内の全テスト実行
python manage.py test
# アプリケーション単位の実行
python manage.py test django_app
# テストモジュール単位の実行
python manage.py test django_app.tests.test_views
# テストクラス単位の実行
python manage.py test django_app.tests.test_views.TestTaskCreateView

インタープリターの実行

「shell」を指定しコマンド実行すると、Djangoプロジェクトの設定を読み込みインタープリターを起動します。

Djangoのライブラリが使えるため、主にモデルを呼び出しデータベース操作をテストする用途などで使えます。

python manage.py shell

Djangoプロジェクトの全体構造

Djangoは、1つのWebアプリを1プロジェクト（1ディレクトリ）で管理します。

また、プロジェクトはプロジェクト全体に関わる設定を記述したファイル群（1ディレクトリ）と機能単位にまとめたアプリケーション（これも1ディレクトリ）で構成されます。

プロジェクトは1つ以上のアプリケーションが必要になり、全ての機能を1アプリケーションで構成することも可能です。

しかし、多機能なWebアプリケーション開発の場合、1ファイルのコード量が増加し複雑になるため、あまりおすすめできません。

さらに、各アプリケーションが互いに依存しないよう独立性を保つことで、アプリケーションを削除や使い回しなど再利用性と拡張性につながります。

Djangoプロジェクトのディレクトリ/ファイル構成

ここでは、django-adminコマンドによるプロジェクト自動生成とmanage.pyコマンドによるアプリケーション作成を実行します。

また、初期状態のDjangoプロジェクトのディレクトリ/ファイル構成を考えます。

ただし、templatesディレクトリやindex.htmlが自動生成されないため、テンプレートは追加しています。

django_project
├── django_app
│   ├── migrations
│   │   └── __init__.py
│   ├── templates
│   │   └── index.html
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── tests.py
│   └── views.py
├── django_project
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
└── manage.py

Django==5.2.7にて実行しています。

以下は、プロジェクト用ディレクトリ/ファイル構成とアプリケーション用ディレクトリ/ファイル構成に分けて端的な説明を記載しています。

最上位ディレクトリに配置されているmanage.pyは、コマンド実行用ファイルになります。