Djangoと.gitignore: ベストプラクティス

Djangoプロジェクトでの.gitignoreファイルの作成と配置について説明します。.gitignoreファイルは、Gitバージョン管理システムが追跡すべきでないファイルやディレクトリを指定するために使用されます。

.gitignoreの作成場所

.gitignoreの保存場所は、gitを使った際に作られる .git と同じフォルダが好ましいです。つまり、プロジェクトの中で最上位にあるべきです。Djangoアプリの公開方法で言えば、「src」フォルダと並列に作るべきです。

<プロジェクトの最上位フォルダ>
├── .git
├──  .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── src
    ├── （ほか省略）
    ├── manage.py
    └── （省略）

Djangoプロジェクトのための.gitignore

Djangoプロジェクトで使っている.gitignoreは以下のとおりです。ベースは、gitignore.ioを参考に作成し、以下のフォルダだけ追記しています。

• mediaフォルダ「media_local」
• デプロイ後に使用しない「local.py」
• シークレットキーなどを保存するフォルダ「auth」

#あとから追記分（オリジナル）
media_local/
media_local
local.py
auth/
auth

# Created by [gitignore.io](^7^)
# Edit at [gitignore.io](^8^)

### Django ###
*.log
*.pot
*.pyc
__pycache__/
local_settings.py
db.sqlite3
db.sqlite3-journal
media

# If your build process includes running collectstatic, then you probably don't need or want to include staticfiles/ 
# in your Git repository. Update and uncomment the following line accordingly.
# <django-project-name>/staticfiles/

### Django.Python Stack ###
# Byte-compiled / optimized / DLL files
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
#  Usually these files are written by a python script from a template
#  before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo

# Django stuff:

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
#   However, in case of collaboration, if having platform-specific dependencies or dependencies
#   having no cross-platform support, pipenv may install dependencies that don't work, or not
#   install all needed dependencies.
#Pipfile.lock

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

以上がDjangoプロジェクトでの.gitignoreの作成と配置についての基本的なガイドラインです。これらの情報を適切に使用することで、プロジェクトの管理がより簡単になります。