settings.pyの機密情報をGitHubで公開しない方法【Djangoでアプリ開発】

概要

アプリ開発しつつ今後デプロイすることを考えGitHubにデータをプッシュしていた時にふと、

「あれ、これデータベースの情報（ユーザ名やパスワードを記載していた）とか秘密鍵とか、見えちゃダメでは？でもsetting.pyってデプロイ時にはGitHubにプッシュするものでは？ん？(。´・ω・)」

となったため、調べた結果を備忘録として残します。

実施する事

• local_settings.pyを作成し、その中に公開したくない情報を記載
  (例)

SECRET_KEY = `秘密鍵`
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'プロジェクトで使用するデータベース名`
        'USER': `MySQLのユーザー名`
        'PASSWORD': `MySQLのパスワード`,
    }
}

• settings.pyに下記のコードを追加

try:
    from .local_settings import *
except ImportError:
    pass

• .gitignoreにlocal_settings.pyを追加。（その他の.gitignoreに記載すべき情報はhttps://www.toptal.com/developers/gitignore を用いると簡単に作成できます。）

参考サイト