Django でプロジェクトを始める

Django でウェブサイトを構築するとき、手順や注意したほうがいいことをまとめます。

インストール

何はともあれ、まずは仮想環境をつくります。

$ python -m venv .venv

で、仮想環境に入ってから pip を使って Django をインストールします。

$ source .venv/bin/activate
$ pip install Django

プロジェクトの作成

ここからが本番で、プロジェクトを作成するときに作られるディレクトリーを分かりやすくするため、プロジェクト名を config にします。

$ django-admin startproject config .

カスタムユーザーの作成

ユーザーモデルについて、Django ドキュメントに次の記載があります。

新しくプロジェクトを始める場合は、デフォルトの User で十分である場合でも、カスタムユーザーモデルを作成することを強く推奨します。

Django の認証方法のカスタマイズ

ログイン機能を利用するプロジェクトの場合は指示に従って、まずはカスタムユーザーのためのアプリを作成します。

$ python manage.py startapp users

次に settings.py の INSTALLED_APP に users アプリを追加します。また、認証に users アプリの User モデルを使用するよう、AUTH_USER_MODEL を追記します。

...
INSTALLED_APPS = [
  'django.contrib.admin',
...
  'djanog.contrib.staticfiles',
  'users',
]
...
AUTH_USER_MODEL = 'users.User'

.venv/lib/python/django/contrib/auth/models.py から AbstractUser を users/models.py にコピーし、クラス名を User に変更してカスタムユーザーモデルを作成します。

マイグレーション

データベースにユーザー用のテーブルを作成するため、マイグレーションを作成して実行します。

$ python manage.py makemigrations
$ python manage.py migrate

メールアドレスでログイン

ユーザー名ではなくメールアドレスでログインする場合は .venv/lib/python/django/contrib/auth/models.py から UserManager を users/models.py にコピーし、次のように UserManager を修正します。

class UserManager(UserManager):

  def _create_user(self, email, password, **extra_fields):
    email = self.normalize_email(email)
    user = self.model(email=email, **extra_fields)
    user.password = make_password(password)
    user.save(using=self._db)
    return user

  def create_user(self, email, password=None, **extra_fields):
    extra_fields.setdefault("is_staff", False)
    extra_fields.setdefault("is_superuser", False)
    return self._create_user(email, password, **extra_fields)

  def create_superuser(self, email=None, password=None, **extra_fields):
    extra_fields.setdefault("is_staff", True)
    extra_fields.setdefault("is_superuser", True)

    if extra_fields.get("is_staff") is not True:
      raise ValueError("Superuser must have is_staff=True.")
    if extra_fields.get("is_superuser") is not True:
      raise ValueError("Superuser must have is_superuser=True.")

    return self._create_user(email, password, **extra_fields)